Skip to content

Development docs

Start Here

New developer? - Setup: Dev Environment Setup — Local setup guide - Test: Live Testing — Local testing workflows - Contribute: Testing Guidelines — Test conventions - Architecture: Architecture — How the code works

Quick reference: | Task | Documentation | |------|---------------| | Run backend locally | Live Testing | | Run tests | Testing Guidelines | | Understand architecture | Architecture | | Deploy changes | Change to Production |

All Development Documentation

  • Local testing flows (recommended): live-testing.md
  • Local + VPS setup (recommended): dev-environment-setup.md
  • Backend testing conventions: testing-guidelines.md
  • Coverage policy and workflows: test-coverage.md
  • Development playbooks (task workflows): playbooks/README.md

Code Annotations (Demo)

This project uses MkDocs Material code annotations to provide inline context for complex configurations:

# Example docker-compose.yml
services:
  api:
    image: healtharchive:latest
    ports:
      - "8001:8001" # (1)
    environment:
      - HEALTHARCHIVE_DATABASE_URL=sqlite:///data.db # (2)
  1. Standard FastAPI port for local development.
  2. Default SQLite path inside the container.