Developer onboarding¶
Target time: under 30 minutes on a machine with Docker and Git.
Steps¶
- Clone this repository and
cdinto the project root. - Environment: copy
.env.exampleto.envand set secrets (Postgres password, JWT secret, encryption key). - Start: run
docker compose up -d --wait(ormake upif available). - Database + dev users (with the API container running):
This runs
alembic upgrade headand creates (if missing):
| Password | Role | |
|---|---|---|
| admin@test.com | password123 | admin |
| operator@test.com | password123 | operator |
| viewer@test.com | password123 | viewer |
- API: open
http://localhost:8001/docs(or your mapped API port) and use POST /api/v1/auth/token with the email/password above. - UI: production bundle is proxied through nginx —
http://localhost:3001maps/api→ API. Runmake seed-dbfirst, then sign in withadmin@test.com/password123. For local dev:cd services/ui && npm run dev(Vite proxies/apito the API port, default 8001).
Scripts¶
scripts/onboard.sh— bootstrap helper (adjust for your compose layout).scripts/load-test.sh— optional API load smoke (requirescurl,jq, running API).scripts/verify-onboarding-time.sh— wrapsonboard.shand checks elapsed time.
Tests¶
- API:
cd services/api && .venv/bin/python -m pytest tests/ -v - UI E2E:
cd services/ui && npm run test:e2e