docs: CHANGELOG.md (Keep a Changelog) + README quick-start fixes
CHANGELOG.md: Keep-a-Changelog formaat met [Unreleased], [0.9.0]-release, en compact-historie. Klaar voor v1.0.0 release-notes. README: - Test-count 69 → 445 (was outdated) - Quick-start claim over auto-erd-watch in `npm run dev` corrigeren (npm run db:erd:watch is optioneel, niet automatisch) - Env-vars-tabel uitgebreid: CRON_SECRET (productie), Sentry DSN + source-map vars (optioneel) - CHANGELOG-link in Documentation-sectie Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
54a2511476
commit
7529fd54bc
2 changed files with 92 additions and 3 deletions
10
README.md
10
README.md
|
|
@ -49,6 +49,7 @@ Scrum4Me biedt een lichtgewicht, web-based oplossing voor het beheren van sprint
|
|||
|
||||
## Documentation
|
||||
|
||||
- [CHANGELOG.md](CHANGELOG.md) — release-historie (Keep a Changelog)
|
||||
- [docs/INDEX.md](docs/INDEX.md) — generated index of all docs (front-matter driven)
|
||||
- [docs/glossary.md](docs/glossary.md) — domain terms (PBI, Story, MCP-job, etc.)
|
||||
- [CLAUDE.md](CLAUDE.md) / [AGENTS.md](AGENTS.md) — agent instructions
|
||||
|
|
@ -152,7 +153,7 @@ npm run dev
|
|||
npm test
|
||||
```
|
||||
|
||||
Verwacht: alle 69 tests slagen, 0 failures.
|
||||
Verwacht: alle 445 tests slagen, 0 failures.
|
||||
|
||||
**API curl-tests (vereist lopende dev server + API token):**
|
||||
|
||||
|
|
@ -175,7 +176,7 @@ Handmatige generatie:
|
|||
npm run db:erd
|
||||
```
|
||||
|
||||
Tijdens lokale development draait `npm run dev` naast Next.js ook `npm run db:erd:watch`. Bij wijzigingen in `prisma/schema.prisma` wordt `docs/assets/erd.svg` automatisch opnieuw gegenereerd.
|
||||
Optioneel: `npm run db:erd:watch` parallel aan `npm run dev` om bij wijzigingen in `prisma/schema.prisma` `docs/assets/erd.svg` automatisch opnieuw te genereren.
|
||||
|
||||
Gebruik `npx prisma db push` alleen om het schema naar de database te synchroniseren. Gebruik `npm run db:erd` om lokaal Prisma Client en de ERD te genereren. Gebruik in CI uitsluitend `npx prisma generate --generator client`.
|
||||
|
||||
|
|
@ -198,8 +199,11 @@ Zie [.env.example](.env.example).
|
|||
| Variabele | Verplicht | Doel |
|
||||
|---|---:|---|
|
||||
| `DATABASE_URL` | Ja | PostgreSQL connection string voor Prisma |
|
||||
| `DIRECT_URL` | Nee | Directe Neon connection string voor migraties |
|
||||
| `DIRECT_URL` | Nee | Directe Neon connection string voor migraties (Prisma `directUrl`) |
|
||||
| `SESSION_SECRET` | Ja | Minimaal 32 tekens; gebruikt door iron-session |
|
||||
| `CRON_SECRET` | Productie | Bearer-secret voor `/api/cron/*` routes — required als crons aan staan |
|
||||
| `NEXT_PUBLIC_SENTRY_DSN` | Nee | Sentry DSN — zonder is de SDK een no-op |
|
||||
| `SENTRY_ORG` / `SENTRY_PROJECT` / `SENTRY_AUTH_TOKEN` | Nee | Source-map upload tijdens build |
|
||||
| `NODE_ENV` | Nee | Wordt door Node/Vercel gezet |
|
||||
|
||||
Vercel Analytics gebruikt geen project-specifieke environment variabele in deze app; de component staat in `app/layout.tsx`.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue