Start with architecture if you're new. Everything else is reference.
| Doc | What's in it |
|---|---|
| architecture.md | How the pieces fit: clients, API, scrapers, OCR, DB, background jobs |
| development.md | Run everything locally, tests, lint, common breakages |
| backend.md | Flask code layout, services, config knobs, DB + migrations, scheduler |
| api-reference.md | Every /api route, params, auth, response shapes |
| frontend.md | React app layout, routing, data fetching, PWA, build |
| mobile.md | Flutter app layout, build flags, signing, translations |
| API_KEYS.md | Secrets and env vars, where each one lives |
| SUPABASE_AUTH.md | Supabase Auth setup and the token exchange |
| SUPABASE_WEB.md | Web-specific Supabase setup (redirect URLs, Google) |
| azure-deployment.md | Full Azure walkthrough (App Service, SWA, ACR, Postgres) |
| COST.md | Keep GitHub at $0 (Free plan, public repos, manual deploys) |
| GITHUB_ACTIONS.md | What each workflow does (CI free, deploys manual) |
| changelog.md | What changed in each big round of work + deploy notes |
GitHub Wiki (short contributor map; sync from repo wiki/): MediScan wiki.
Open source:
CONTRIBUTING.md— PR checks, conventionsSECURITY.md— vulnerability reportingCODE_OF_CONDUCT.md— community standardsLICENSE/NOTICE— MIT + disclaimers
Flutter has its own longer guide in mobile/README.md.