Development setup

Requires: macOS or Linux, Python 3.12, Docker/OrbStack, gh CLI.

python3.12 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev,docs]"
pre-commit install
cp .env.example .env
docker compose up -d db
uvicorn backend.app.main:app --reload
# Visit http://localhost:8000/health

Run tests:

pytest

Lint and type-check:

ruff check .
ruff format --check .
mypy backend/app

Build the docs site locally:

mkdocs build --strict --config-file docs/mkdocs.yml