Quickstart¶

Purpose¶

Get OpenSESA running quickly on a local machine.

When To Use This Page¶

• first-time setup on a developer machine
• validating a clean checkout quickly
• confirming local runtime health before deeper work

Fast Bootstrap Commands¶

# 1) Start local stack
docker compose up -d --build

# 2) Apply migrations
docker compose run --rm app python manage.py migrate

# 3) Validate runtime
docker compose run --rm app python manage.py check

# 4) Optional: create admin account
docker compose run --rm app python manage.py createsuperuser

Open: http://localhost:8001

What Happens During Bootstrap¶

sequenceDiagram
    autonumber
    participant Dev as Developer
    participant Compose as Docker Compose
    participant App as app
    participant DB as db
    participant Redis as redis

    Dev->>Compose: up -d --build
    Compose->>DB: start postgres
    Compose->>Redis: start redis
    Compose->>App: start django
    Dev->>App: run migrate/check commands

Quick Health Checks¶

docker compose ps
docker compose logs -f app
docker compose logs -f celery