Guides

Step-by-step guides for common development and operational tasks.

Development Guides

• Deployment - Deploy to staging (no production environment exists yet)
• Testing - Write and run tests
• Seed Data - Manage catalog and test data
• GitHub Workflow - Branching, PRs, and CI/CD
• Documentation - Write and build documentation
• Design Review - Design review workflow for custom designs

Stakeholder Workflows

• Eefje Intake Process - Bug/feature intake from business owner: triage, todos, retest loop

Analytics & Monitoring

• PostHog Analytics - Product analytics, feature flags, A/B testing

Quick Reference

Run Tests

BackendFrontendE2E

cd backend
pytest

cd frontend
npm run test

cd frontend
npm run test:e2e

Build for Production

BackendFrontend

pip install -r requirements.txt
python manage.py collectstatic --no-input
python manage.py migrate

npm ci
npm run build

Documentation

MkDocsStorybookTypeDoc

cd docs && mkdocs serve   # http://localhost:8000

cd frontend && npm run storybook   # http://localhost:6006

cd frontend && npm run docs:typedoc