Skip to content

Local Development

Prerequisites

  • Python 3.11+
  • uv (fast Python package installer)
  • Docker & Docker Compose
  • make

Setup Instructions

  1. Install Dependencies 

    uv pip install --system -r app/pyproject.toml[dev]

  2. Run Local Infrastructure Spin up the local services (Postgres, Redis, API, Observability stack): 

    make run
    Local Services Local Services Local Services

  3. Run Tests Execute the test suite: 

    make test

  4. Serve Documentation Preview documentation changes locally: 

    make docs-serve

API Access

  • The API is available at http://localhost:8000.
  • The Traefik dashboard is accessible if enabled.
  • Prometheus and Grafana run on ports 9090 and 3000 respectively.