study-setup

Appearance

Development Guide ​

Documentation for contributors: how the project is structured, how to run it locally, and how the major pieces fit together.

Overview ​

  • Architecture — Layout, local runtime, data model, and background tasks.

Deep dives ​

  • Frontend — React 19, Vite, TanStack Router/Query, auth, and data fetching.
  • Backend — Django + Ninja API, Allauth headless auth, Celery, and storage.
  • Docs — How this VitePress site is built, configured, and run.
  • Build & CI/CD — GitLab pipeline, Helm charts, and how to test the whole thing locally.

Libraries ​

Vendored packages under backend/lib/, documented from their READMEs.

  • eventcore — Formal Commands and Events for Django apps.
  • tracker — Progress tracking for Celery workloads.
  • uncouple — Typed configuration from environment variables.