Skip to content

README is out of date: wrong hosting provider, missing migration file, incomplete scripts #33

Description

@royalpinto007

What is wrong

Three statements in README.md are out of date, and each one costs a new contributor time.

1. The hosting row is wrong

README.md line ~25:

| Hosting   | Vercel                       |

The project deploys to Cloudflare Workers via OpenNext. Evidence in the repo: wrangler.jsonc, wrangler.production.jsonc, open-next.config.ts, and the package.json scripts:

"preview": "opennextjs-cloudflare build && opennextjs-cloudflare preview",
"deploy": "opennextjs-cloudflare build && opennextjs-cloudflare deploy --config wrangler.production.jsonc",

2. The migration file it names does not exist

README.md lines ~105 to 112 and line ~64 both point at supabase/migrations/0001_init.sql, including an instruction to "paste supabase/migrations/0001_init.sql into the SQL editor". The only file in supabase/migrations/ is 20260606150000_add_case_evidence_fields.sql. A new contributor following the README hits a missing file and has no way to build a working schema.

3. The scripts section is incomplete

README.md lines ~120 to 126 list only dev, build, and db. package.json also defines test, lint, format, preview, deploy, upload, cf-typegen, and test:e2e.

What to change

In README.md:

  1. Change the Hosting row to Cloudflare Workers (OpenNext).
  2. Fix the migration references. Point at the actual supabase/migrations/ directory and npx supabase db push rather than naming a specific file, so this cannot rot again. If you find the init schema is genuinely not committed, say so in the PR rather than inventing a path, that is a separate problem worth a maintainer's attention.
  3. Add npm test, npm run lint, npm run format, and npm run deploy to the "Useful scripts" block with one-line comments.
  4. Optional, while you are in there: the "Project structure" tree omits several shipped routes, including app/(public)/search/, app/(public)/stats/, app/(public)/teams/, app/(public)/tools/, app/feed.xml/, app/api/search/, app/api/export/, app/api/comments/, and app/api/newsletter/. Adding them is welcome but keep it in the same PR only if it stays readable.

Docs only, no code changes needed.

Verify

npm run format
npx prettier --check .

Comment here to claim it and ask anything you are unsure about. You will usually get a reply within a day.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions