Skip to content

Guides

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

Development Guides

  • Development - Local setup, build commands, code style, branches, and pull requests
  • Deployment - Deploy to staging and production (production via scripts/deploy-production.sh)
  • Testing - Write and run tests (pytest, Jest, Playwright, k6)
  • Seed Data - Manage catalog and test data
  • GitHub Workflow - Branching, PRs, CI gates, auto-merge, promotion and the automation workflows
  • Documentation - Build and deploy this documentation site
  • Admin Guide - Working in the admin
  • Design Review - Design review workflow for custom designs

Stakeholder Workflows

  • Eefje Intake Process - Bug/feature intake from the business owner: intake assistant, Ivar's /ready, todos, retest loop

Analytics & Monitoring

Quick Reference

Run Tests

cd backend
pytest
cd frontend
npm run test
cd frontend
npx playwright test --project=chromium --grep @smoke

Build for Production

pip install -r requirements.txt
python manage.py collectstatic --no-input
python manage.py migrate
npm ci
npm run build

Documentation

pip install -r docs/requirements.txt
cd docs && mkdocs serve -a localhost:8001   # port 8000 is the Django backend
cd frontend && npm run storybook   # http://localhost:6006
cd frontend && npm run docs:typedoc