H.3 — Add a Deployment section to README
What's wrong
No production deploy instructions anywhere. Future maintainers have to reverse-engineer what env vars are needed, where uploads live, how migrations are applied, etc.
How to fix
After the dev setup section, add a "Deployment" heading covering:
- Container image: how it's built (
Dockerfile), what platform we target.
- Required environment variables: link to or duplicate the schema from E.3 (
server/plugins/validate-env.ts).
- Database: which Postgres version we run, how to point
DATABASE_URL at it.
- Migrations: how
prisma migrate deploy runs in CI/CD (one-shot, not on every container start — see E.6).
- Upload storage: required volume mount or S3 bucket (see F.5).
- Secrets: where production
BETTER_AUTH_SECRET, SMTP password, etc. live (AWS Secrets Manager? GitHub Secrets?).
- Rollback: how we roll back a bad deploy.
Files
Severity
M.
Acceptance
H.3 — Add a Deployment section to README
What's wrong
No production deploy instructions anywhere. Future maintainers have to reverse-engineer what env vars are needed, where uploads live, how migrations are applied, etc.
How to fix
After the dev setup section, add a "Deployment" heading covering:
Dockerfile), what platform we target.server/plugins/validate-env.ts).DATABASE_URLat it.prisma migrate deployruns in CI/CD (one-shot, not on every container start — see E.6).BETTER_AUTH_SECRET, SMTP password, etc. live (AWS Secrets Manager? GitHub Secrets?).Files
README.mdSeverity
M.
Acceptance