Skip to content

Developer Guide

Welcome to the SWEN developer documentation.

  • Architecture

    Domain-Driven Design, hexagonal architecture, CQRS, bounded contexts. Start here.

  • Backend

    FastAPI app structure, DI, JWT auth, settings, key services.

  • Frontend

    React 19, TanStack Router/Query, Zustand, Radix UI, auth flow.

  • ML Service

    FastAPI ML service internals, lifespan, shared infrastructure, training data flow.

  • Database

    PostgreSQL schema, two databases, CLI init, key tables.

  • Testing

    Test pyramid, Testcontainers, markers, CI policy.

  • CI / GitHub Actions

    All workflows explained: CI, Docker publish, Dependabot.

  • Release Process

    How to cut a release, what tags are created, how to update a running deployment.

  • Run all tests: make test
  • Run backend: make backend
  • Architecture diagram: architecture.md
  • API docs (Swagger): http://localhost:8000/docs (when running locally)
  • Test README: see Testing