Documentation Hub

March 5, 2026 · View on GitHub

Welcome. This folder is organized by developer journey so you can find the right guide quickly.

Start Here ✨

If this is your first 10 minutes in the project:

  1. GETTING_STARTED.md
  2. COMMANDS.md
  3. DEVELOPMENT.md

Read by Role

New Team Member

  1. GETTING_STARTED.md
  2. TIPS_AND_TRICKS.md
  3. DEVELOPMENT.md

Feature Developer

  1. DEVELOPMENT.md
  2. API.md
  3. TESTING.md
  4. DATABASE.md

Tech Lead or Reviewer

  1. ARCHITECTURE.md
  2. PROJECT_STRUCTURE.md
  3. CONFIGURATION.md
  4. BOOTSTRAP_CHECKLIST.md

Core Guides 📘

GuideWhy read it
GETTING_STARTED.mdRun the project locally and validate setup
COMMANDS.mdFind every make target by purpose
DEVELOPMENT.mdBuild the first feature and apply day-to-day conventions
ARCHITECTURE.mdReview layering rules and design tradeoffs
API.mdConsume the API contract and envelope format
TESTING.mdFollow test structure and assertion patterns
DATABASE.mdWork with migrations and DB setup safely
CONFIGURATION.mdConfigure runtime behavior via environment variables
TIPS_AND_TRICKS.mdShortcuts for faster local iteration
REFERENCES.mdExternal links curated for practical extension work
  • Main project overview: ../README.md
  • Contributing workflow: ../CONTRIBUTING.md
  • Swagger UI (when running): http://localhost:8000/docs
  • ReDoc (when running): http://localhost:8000/redoc