1.1 KiB
1.1 KiB
Development workflow
This page describes a contributor-friendly local dev loop.
Prereqs
- Python 3.12+
- Node 22+
- Docker + Docker Compose v2 (
docker compose) uv(installed automatically bymake backend-syncin CI; for local install see https://docs.astral.sh/uv/)
Fast local loop (DB in Docker, apps on host)
- Start Postgres (via compose)
cp .env.example .env
# Configure .env as needed (see root README for auth-mode notes)
docker compose -f compose.yml --env-file .env up -d db
- Install deps
make setup
- Apply DB migrations
make backend-migrate
- Run backend (dev)
cd backend
uv run uvicorn app.main:app --reload --host 0.0.0.0 --port 8000
- Run frontend (dev)
In another terminal:
cd frontend
npm run dev -- --hostname 0.0.0.0 --port 3000
Open:
- Frontend: http://localhost:3000
- Backend health: http://localhost:8000/healthz
Notes
- If you want the fully-containerized stack instead, see the root README’s compose instructions.
- If you add new env vars, prefer documenting them in
.env.exampleand linking from docs rather than pasting secrets.