Installation and Setup

Using venv

1. Clone the Repository:

 git clone https://github.com/yourusername/yourproject.git
 cd yourproject

2. Create and Activate a Virtual Environment:

  python3 -m venv venv
  source venv/bin/activate  # On Windows use `.\venv\Scripts\activate`t

3. Install Dependencies:

  pip install -r requirements.txt

4. Set Up Environment Variables: Create a .env file in the project root and add your environment variables (e.g., database configuration, secret key).

5. Apply Migrations:

  python manage.py migrate

6. Create a Superuser:

  python manage.py createsuperuser

7. Run the Development Server:

  python manage.py runserver

Using Docker:

1. Clone the Repository:

  git clone https://github.com/yourusername/yourproject.git
  cd yourproject

2.Create a Dockerfile in the project root:

  FROM python:3.10-slim

  WORKDIR /app

  COPY requirements.txt .
  RUN pip install --no-cache-dir -r requirements.txt

  COPY . .

  ENV PYTHONUNBUFFERED=1

  CMD ["gunicorn", "--bind", "0.0.0.0:8000", "yourproject.wsgi:application"]

3. Create a docker-compose.yml file in the project root:

  version: '3'

  services:
    web:
      build: .
      command: gunicorn yourproject.wsgi:application --bind 0.0.0.0:8000
      volumes:
        - .:/app
      ports:
        - "8000:8000"
      env_file:
        - .env
      depends_on:
        - db

    db:
      image: postgres:13
      volumes:
        - postgres_data:/var/lib/postgresql/data
      environment:
        POSTGRES_DB: yourdbname
        POSTGRES_USER: yourdbuser
        POSTGRES_PASSWORD: yourdbpassword

  volumes:
    postgres_data:

4. Set Up Environment Variables: Create a .env file in the project root and add your environment variables:

  SECRET_KEY=your-secret-key
  DEBUG=True
  DB_NAME=yourdbname
  DB_USER=yourdbuser
  DB_PASSWORD=yourdbpassword
  DB_HOST=db
  DB_PORT=5432

5. Build and Run the Docker Containers:

  docker-compose up --build

6. Apply Migrations: Open a new terminal and run:

  docker-compose exec web python manage.py migrate

7. Create a Superuser:

  docker-compose exec web python manage.py createsuperuser

Your application should now be up and running. You can access it at http://localhost:8000