Skip to content

Development Getting Started

This page is the quickest path from clone to productive local development.

Prerequisites

  • Docker and Docker Compose
  • Git
  • A populated .env file in the repository root

Bootstrap Flow

flowchart TD
    A[Clone Repository] --> B[Create .env]
    B --> C[docker compose up -d --build]
    C --> D[docker compose run --rm app python manage.py migrate]
    D --> E[docker compose run --rm app python manage.py check]
    E --> F[Run pytest collect]

First-Day Commands

docker compose up -d --build
docker compose run --rm app python manage.py migrate
docker compose run --rm app python manage.py check
docker compose run --rm app sh -c "DJANGO_SETTINGS_MODULE=app.settings_test PYTHONPATH=. pytest --collect-only -q"

Expected Results

  • Compose services start without crash loops.
  • manage.py check reports no configuration issues.
  • Test collection succeeds and lists discovered tests.

Initial Validation Checklist

  • docker compose ps shows healthy long-running services.
  • You can access the local app endpoint.
  • At least one targeted test command completes successfully.

Work in small slices

Start by editing one module at a time and run targeted tests before full-suite checks.