1.5 KiB
1.5 KiB
[Project name]
Replace the heading above with the project's name, and this line with one sentence describing what this app does for users.
Run & Operate
pnpm --filter @workspace/api-server run dev— run the API server (port 5000)pnpm run typecheck— full typecheck across all packagespnpm run build— typecheck + build all packagespnpm --filter @workspace/api-spec run codegen— regenerate API hooks and Zod schemas from the OpenAPI specpnpm --filter @workspace/db run push— push DB schema changes (dev only)- Required env:
DATABASE_URL— Postgres connection string
Stack
- pnpm workspaces, Node.js 24, TypeScript 5.9
- API: Express 5
- DB: PostgreSQL + Drizzle ORM
- Validation: Zod (
zod/v4),drizzle-zod - API codegen: Orval (from OpenAPI spec)
- Build: esbuild (CJS bundle)
Where things live
Populate as you build — short repo map plus pointers to the source-of-truth file for DB schema, API contracts, theme files, etc.
Architecture decisions
Populate as you build — non-obvious choices a reader couldn't infer from the code (3-5 bullets).
Product
Describe the high-level user-facing capabilities of this app once they exist.
User preferences
Populate as you build — explicit user instructions worth remembering across sessions.
Gotchas
Populate as you build — sharp edges, "always run X before Y" rules.
Pointers
- See the
pnpm-workspaceskill for workspace structure, TypeScript setup, and package details