TudorandClaude Opus 5
eaf5e5d180
The README still opened on "Primary School Compass", a KS2 tool for Wandsworth and Merton served by FastAPI and vanilla JavaScript with Chart.js. Every layer of that sentence is now wrong: coverage is England-wide across KS2, KS4, all-through and post-16, Next.js owns the public UI, and school data comes from dbt-built `marts.*` rather than CSVs loaded at startup. The setup instructions walked a reader into a virtualenv and a CSV import that cannot build the current schema, so following the docs produced an empty database and a wrong mental model at the same time. Replace the narrative docs with two reference documents that were checked against the code: docs/ARCHITECTURE.md for request flow, data ownership, the backend/frontend module boundaries and the real publication sequence, and docs/DEVELOPMENT.md for the checks that actually run, including the container and CI version skew that makes "just run pytest" misleading. The env examples drifted the same way. ALLOWED_ORIGINS is a JSON array, not a comma-separated list; the frontend needs FASTAPI_URL, DATABASE_URL and PAYLOAD_SECRET, none of which were documented; and RATE_LIMIT_BURST, DEFAULT_PAGE_SIZE and MAX_PAGE_SIZE were presented as tuning controls the routes do not consult. Each is now stated as it behaves. MIGRATION_SUMMARY.md keeps its content but gains a banner, because it reads like setup instructions and is not. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016y2J6bs8gbuSJbH18w7Tan
16 lines
789 B
Markdown
16 lines
789 B
Markdown
# Frontend deployment
|
|
|
|
Next.js and Payload run in the same frontend container. The maintained deployment
|
|
procedure is [docs/DEPLOY.md](../docs/DEPLOY.md), with the production and staging
|
|
Portainer compose files at the repository root.
|
|
|
|
The frontend Dockerfile builds a standalone Next.js image. Runtime configuration
|
|
supplies `FASTAPI_URL`, `DATABASE_URL` and `PAYLOAD_SECRET`; uploaded CMS media is
|
|
persisted in a volume. Promote the built image through the repository's Gitea
|
|
workflow after human staging approval.
|
|
|
|
Earlier Vercel and standalone deployment recipes have been retired from this file
|
|
because they do not describe the current CMS, persistence and promotion setup.
|
|
See [development](../docs/DEVELOPMENT.md) for checks and
|
|
[publishing](docs/PUBLISHING.md) for CMS operations.
|