Commit 408dc356 authored by adam.fisher1's avatar adam.fisher1

Update change layout README.md

parent 9417178d
...@@ -4,60 +4,55 @@ TODO: Give a short introduction of your project. Let this section explain the ob ...@@ -4,60 +4,55 @@ TODO: Give a short introduction of your project. Let this section explain the ob
Prerequisites Prerequisites
Ensure you have the following software installed: Ensure you have the following software installed:
Python (>= 3.9)
Django (>= 3.2)
Node.js (>= 14) * Python (>= 3.9)
npm (>= 6.14)
Git * Django (>= 3.2)
Virtualenv (for Python virtual environments)
Setting Up Development Environment * Node.js (>= 14)
* npm (>= 6.14)
* Git
* Virtualenv (for Python virtual environments)
***Setting Up Development Environment***
1. Clone the Repository 1. Clone the Repository
First, clone the repository to your local machine: First, clone the repository to your local machine:
bash *git clone https://gitlab.com/yourusername/operation-search.git
Copy code cd operation-search*
git clone https://gitlab.com/yourusername/operation-search.git
cd operation-search
2. Create a Virtual Environment (for Python) 2. Create a Virtual Environment (for Python)
To ensure you're working with the correct version of Python and dependencies, set up a virtual environment: To ensure you're working with the correct version of Python and dependencies, set up a virtual environment:
bash *python -m venv venv
Copy code source venv/bin/activate*
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
3. Install Python Dependencies 3. Install Python Dependencies
Once the virtual environment is activated, install the required Python packages: Once the virtual environment is activated, install the required Python packages:
bash *pip install -r requirements.txt*
Copy code
pip install -r requirements.txt
4. Install Frontend Dependencies 4. Install Frontend Dependencies
This project uses JavaScript for frontend development. To install the necessary frontend dependencies: This project uses JavaScript for frontend development. To install the necessary frontend dependencies:
bash *npm install*
Copy code
npm install ***Building and Deploying the Project***
Building and Deploying the Project
1. Apply Migrations 1. Apply Migrations
Ensure the database is up to date with the latest schema: Ensure the database is up to date with the latest schema:
bash *python manage.py migrate*
Copy code
python manage.py migrate
2. Collect Static Files 2. Collect Static Files
Run this command to gather all the static files (CSS, JS, images) into the appropriate folder: Run this command to gather all the static files (CSS, JS, images) into the appropriate folder:
bash *python manage.py collectstatic*
Copy code
python manage.py collectstatic
3. Start the Development Server 3. Start the Development Server
You can start the Django development server with the following command: You can start the Django development server with the following command:
bash *python manage.py runserver*
Copy code
python manage.py runserver
Visit http://127.0.0.1:8000 in your browser to see the application running locally.
4. Deploy to Production 4. Deploy to Production
For production deployment, follow your specific cloud deployment instructions (e.g., on Azure). Here is a generic overview of the steps: For production deployment, follow your specific cloud deployment instructions (e.g., on Azure). Here is a generic overview of the steps:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment