Development Environment Setup

Follow these steps to set up and run the project in a development environment.

Prerequisites

• Docker and Docker Compose
• Python 3.x
• Git

Backend Setup

1. Create a Python Virtual Environment: It is recommended to use a virtual environment to manage your project's dependencies independently.

   python -m venv venv

2. Activate the Virtual Environment:

   • On Linux/macOS:

     source venv/bin/activate

   • On Windows:

     .\venv\Scripts\activate

3. Install Python Dependencies: With your virtual environment activated, install all required packages from the requirements.txt file.

   pip install -r requirements.txt

4. Set Up Environment Variables: Copy the environment template file and configure it with your own values:

   cp .env.example .env

5. Start the Database: Use Docker Compose to start the database service.

   docker-compose up -d

6. Run Database Migrations: Apply the database migrations to set up the schema using the command format mentioned above.

   python manage.py migrate

7. Run the Development Server: Start the Django development server using the same PYTHONPATH setup.

   python manage.py runserver

Frontend Setup

The frontend code is included as a Git submodule.

To initialize and fetch the frontend code, run the following command from the root of the open_schools_marketplace_backend directory:

git submodule update --init

---