Skip to content

H.3 — Add a Deployment section to README #321

@v-patel

Description

@v-patel

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:

  1. Container image: how it's built (Dockerfile), what platform we target.
  2. Required environment variables: link to or duplicate the schema from E.3 (server/plugins/validate-env.ts).
  3. Database: which Postgres version we run, how to point DATABASE_URL at it.
  4. Migrations: how prisma migrate deploy runs in CI/CD (one-shot, not on every container start — see E.6).
  5. Upload storage: required volume mount or S3 bucket (see F.5).
  6. Secrets: where production BETTER_AUTH_SECRET, SMTP password, etc. live (AWS Secrets Manager? GitHub Secrets?).
  7. Rollback: how we roll back a bad deploy.

Files

  • README.md

Severity

M.

Acceptance

  • A new dev could follow the Deployment section to deploy a fresh environment without asking anyone questions.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions