Source-of-truth design artifacts for Beach Metro, organized by document kind.
docs/
product/ — the PRD
flows/ — per-area flow specs (state machines + walkthroughs)
schema/ — the consolidated data model (source-of-truth backend shapes)
api/ — the REST endpoint / CRUD spec
integrations/ — external-service research and integration plans (Google Maps)
infra/ — infrastructure / tech-stack spec
plan/ — sequenced backend build plan (specs → code)
| Doc | Area | Linear | Status |
|---|---|---|---|
product/beach_metro_PRD.md |
Product requirements | — | Drafted |
design_decisions.md |
Living log of locked design decisions | — | Living |
flows/route_management_flow.md |
Route management | BM-12 | Merged |
flows/people_management_flow.md |
People management (volunteers + captains) | BM-24 | Merged |
flows/finances_flow.md |
Finances (issues, payouts) | BM-25 | Draft |
flows/delivery_recording_flow.md |
Delivery recording (issue actuals) | PRD Flow 5 | Draft |
schema/data_model.md |
Consolidated data model | — | Draft |
api/api_spec.md |
REST endpoints / CRUD | — | Draft |
integrations/google_maps_research.md |
Google Maps Platform research + integration | — | Draft |
infra/infrastructure_spec.md |
Infrastructure / tech stack | — | Draft |
plan/backend_build_plan.md |
Backend build plan (specs → code) | — | Draft |
backend_guide.md |
Backend walkthrough + API quick-reference | — | Living |
open_items.md |
Open calculations / decisions still pending | — | Living |
backend_testing.md |
How to verify the backend (suites + curl) | — | Living |