Compare commits
2 Commits
todo/mvp1-
...
todo/mvp1-
| Author | SHA1 | Date | |
|---|---|---|---|
|
ec4f85e1d0
|
|||
|
6b282ce56b
|
53
CHANGELOG.md
53
CHANGELOG.md
@@ -1,3 +1,56 @@
|
||||
## Unreleased (2026-02-12)
|
||||
|
||||
* test(admin): cover support fallback route and mark todo complete ([4ac74101487e0bb220215328510fd4344c9110e3](https://git.fellies.net/Citali/cms.fellies.org/commits/4ac74101487e0bb220215328510fd4344c9110e3))
|
||||
* test(auth): add registration policy route-flow integration tests ([39178c2d8d9c203ceca63a36012b58173d21d4d4](https://git.fellies.net/Citali/cms.fellies.org/commits/39178c2d8d9c203ceca63a36012b58173d21d4d4))
|
||||
* test(ci): add quality gates, e2e data prep, and i18n integration coverage ([4d4b583cf4dcb0f3b99f74c666af15d3b1a0fc59](https://git.fellies.net/Citali/cms.fellies.org/commits/4d4b583cf4dcb0f3b99f74c666af15d3b1a0fc59))
|
||||
* test(crud): finalize MVP1 gate CRUD contract coverage ([36b09cd9d76049219569bb4828aa292aec78a935](https://git.fellies.net/Citali/cms.fellies.org/commits/36b09cd9d76049219569bb4828aa292aec78a935))
|
||||
* test(e2e): add mvp1 happy path scenarios ([7c4b667bc79a022518d03a52a98060a9c86c673c](https://git.fellies.net/Citali/cms.fellies.org/commits/7c4b667bc79a022518d03a52a98060a9c86c673c))
|
||||
* test(mvp0): complete remaining i18n, RBAC, and CRUD coverage ([3b130568e9bfff9e428c3650c37dd8b1abfbed57](https://git.fellies.net/Citali/cms.fellies.org/commits/3b130568e9bfff9e428c3650c37dd8b1abfbed57))
|
||||
* test(mvp1): add owner invariants and media form coverage ([37f62a8007d6b50e7b53e5785365965c00c74a5b](https://git.fellies.net/Citali/cms.fellies.org/commits/37f62a8007d6b50e7b53e5785365965c00c74a5b))
|
||||
* test(mvp1): expand domain schema and service unit coverage ([24676bd384c39d954b791ff2322a4469ab86a83a](https://git.fellies.net/Citali/cms.fellies.org/commits/24676bd384c39d954b791ff2322a4469ab86a83a))
|
||||
* feat(admin-auth): add first-start onboarding flow and dev db reset command ([7b665ae633e869560654cf1c115d12dc05af1c45](https://git.fellies.net/Citali/cms.fellies.org/commits/7b665ae633e869560654cf1c115d12dc05af1c45))
|
||||
* feat(admin-auth): support username login and add dashboard logout ([b96cd6d8005aea50c49a70540e0fd2afff94c682](https://git.fellies.net/Citali/cms.fellies.org/commits/b96cd6d8005aea50c49a70540e0fd2afff94c682))
|
||||
* feat(admin-i18n): add cookie-based locale runtime and switcher baseline ([b618c8cb5161eef46e80d622156a1e53a732ea35](https://git.fellies.net/Citali/cms.fellies.org/commits/b618c8cb5161eef46e80d622156a1e53a732ea35))
|
||||
* feat(admin): add IA shell and protected section skeleton routes ([bf1a92d129b89811b58d6920a4e09482816988a0](https://git.fellies.net/Citali/cms.fellies.org/commits/bf1a92d129b89811b58d6920a4e09482816988a0))
|
||||
* feat(admin): add posts CRUD sandbox and shared CRUD foundation ([07e5f53793da5aa0b17e62a3a9b99c23a56dbcf0](https://git.fellies.net/Citali/cms.fellies.org/commits/07e5f53793da5aa0b17e62a3a9b99c23a56dbcf0))
|
||||
* feat(admin): add registration policy settings and disabled register state ([d0f731743c789ef836e4573eadece2f4c67c973d](https://git.fellies.net/Citali/cms.fellies.org/commits/d0f731743c789ef836e4573eadece2f4c67c973d))
|
||||
* feat(auth): block protected account deletion in auth endpoints ([0e2248b5c7f72684e4db6d4ab8f306b10f50ac66](https://git.fellies.net/Citali/cms.fellies.org/commits/0e2248b5c7f72684e4db6d4ab8f306b10f50ac66))
|
||||
* feat(auth): bootstrap protected support and first owner users ([411861419f160e3573a71ea67d57af7e0e91de7d](https://git.fellies.net/Citali/cms.fellies.org/commits/411861419f160e3573a71ea67d57af7e0e91de7d))
|
||||
* feat(auth): enforce single-owner invariant in bootstrap flow ([29a6e38ff3b725e4232736c4b5b007a2989acb82](https://git.fellies.net/Citali/cms.fellies.org/commits/29a6e38ff3b725e4232736c4b5b007a2989acb82))
|
||||
* feat(ci): stamp build metadata and validate footer version hash ([af52b8581f7dbe320c92752fcc56b73e37f0c2ba](https://git.fellies.net/Citali/cms.fellies.org/commits/af52b8581f7dbe320c92752fcc56b73e37f0c2ba))
|
||||
* feat(commissions): add customer records and kanban workflow baseline ([994b33e081c3507cbf88820028b819a4fc4b07a0](https://git.fellies.net/Citali/cms.fellies.org/commits/994b33e081c3507cbf88820028b819a4fc4b07a0))
|
||||
* feat(content): add announcements and public news flows ([dbf817c25511b3038b7abe81e4577d3518fd3f19](https://git.fellies.net/Citali/cms.fellies.org/commits/dbf817c25511b3038b7abe81e4577d3518fd3f19))
|
||||
* feat(media): add admin media CRUD preview and storage cleanup ([7d9bc9dca9197e87cc590ad6b49837c5774fcd4f](https://git.fellies.net/Citali/cms.fellies.org/commits/7d9bc9dca9197e87cc590ad6b49837c5774fcd4f))
|
||||
* feat(media): add mvp1 upload pipeline baseline ([5becba602c3aaefbe24ec71414f62b29a155d158](https://git.fellies.net/Citali/cms.fellies.org/commits/5becba602c3aaefbe24ec71414f62b29a155d158))
|
||||
* feat(media): complete mvp1 media foundation workflows ([ad351ed73ab7c76a9e751348ebf943aec5f0d084](https://git.fellies.net/Citali/cms.fellies.org/commits/ad351ed73ab7c76a9e751348ebf943aec5f0d084))
|
||||
* feat(media): default to s3 with local upload fallback ([86a8af25d8c28c2ab19039b56b1c69263c7450c5](https://git.fellies.net/Citali/cms.fellies.org/commits/86a8af25d8c28c2ab19039b56b1c69263c7450c5))
|
||||
* feat(media): scaffold mvp1 media and portfolio foundation ([d727ab8b5b896e5471829a6a1880dc33da28d070](https://git.fellies.net/Citali/cms.fellies.org/commits/d727ab8b5b896e5471829a6a1880dc33da28d070))
|
||||
* feat(media): support local and s3 upload providers ([19738b77d8842f3263e7f049aa47063dcfbd4ae6](https://git.fellies.net/Citali/cms.fellies.org/commits/19738b77d8842f3263e7f049aa47063dcfbd4ae6))
|
||||
* feat(pages): add pages and navigation builder baseline ([281b1d7a1be72af4cff790ca7e97d51cafcd8139](https://git.fellies.net/Citali/cms.fellies.org/commits/281b1d7a1be72af4cff790ca7e97d51cafcd8139))
|
||||
* feat(release): publish gitea release notes and enable production rollback ([ccac669454b46a3918b34df1d3c5f0e5f00aa1d9](https://git.fellies.net/Citali/cms.fellies.org/commits/ccac669454b46a3918b34df1d3c5f0e5f00aa1d9))
|
||||
* feat(settings): manage public header banner in admin ([d1face36c540673486b494d276f5af1621b6e6cb](https://git.fellies.net/Citali/cms.fellies.org/commits/d1face36c540673486b494d276f5af1621b6e6cb))
|
||||
* feat(versioning): show runtime version and git hash in app footers ([3de4d5732e26e06e825986e58ec271d0f0ff4007](https://git.fellies.net/Citali/cms.fellies.org/commits/3de4d5732e26e06e825986e58ec271d0f0ff4007))
|
||||
* feat(web-i18n): add es/fr locales and expand switcher locale set ([de26cb7647cf537a783cc9c77ae447a0f8a09ef6](https://git.fellies.net/Citali/cms.fellies.org/commits/de26cb7647cf537a783cc9c77ae447a0f8a09ef6))
|
||||
* feat(web): complete MVP0 public layout, banner, and SEO baseline ([8390689c8dd81dca5662b842c827a4759a9025e1](https://git.fellies.net/Citali/cms.fellies.org/commits/8390689c8dd81dca5662b842c827a4759a9025e1))
|
||||
* feat(web): render cms pages and navigation from db ([f65a9ea03f39c21ee9b31e7f9100e3a1f522525f](https://git.fellies.net/Citali/cms.fellies.org/commits/f65a9ea03f39c21ee9b31e7f9100e3a1f522525f))
|
||||
* refactor(db): simplify to single prisma schema workflow ([df1280af4a1d24bd9374fc9a005cea9142745d46](https://git.fellies.net/Citali/cms.fellies.org/commits/df1280af4a1d24bd9374fc9a005cea9142745d46))
|
||||
* refactor(media): use asset-centric storage key layout ([3e4f0b6c75c59422675637bf658b6682c22f4a89](https://git.fellies.net/Citali/cms.fellies.org/commits/3e4f0b6c75c59422675637bf658b6682c22f4a89))
|
||||
* docs(adr): add glossary pages and ADR baseline structure ([cec87679ca5efcf70883b6c78245f8197a8a4432](https://git.fellies.net/Citali/cms.fellies.org/commits/cec87679ca5efcf70883b6c78245f8197a8a4432))
|
||||
* docs(crud): add implementation examples and complete docs task ([7b4b23fc4ffdd7e6be8af9da6b2026067acbd35e](https://git.fellies.net/Citali/cms.fellies.org/commits/7b4b23fc4ffdd7e6be8af9da6b2026067acbd35e))
|
||||
* docs(gitflow): add branch protection verification checklist ([f9f2b4eb15bd42690891bdc8e4d34c5e55c343dc](https://git.fellies.net/Citali/cms.fellies.org/commits/f9f2b4eb15bd42690891bdc8e4d34c5e55c343dc))
|
||||
* docs(i18n): add conventions guide and wire docs navigation ([5872593b014e527ef884ea89053f9cf191edf5dc](https://git.fellies.net/Citali/cms.fellies.org/commits/5872593b014e527ef884ea89053f9cf191edf5dc))
|
||||
* docs(ops): add environment and deployment runbook ([4d6e17a13b3ee4a00d93713a223871e96ee94550](https://git.fellies.net/Citali/cms.fellies.org/commits/4d6e17a13b3ee4a00d93713a223871e96ee94550))
|
||||
* docs(ops): add staging deployment checklist and evidence template ([637dfd2651a8ad7b0900c0a87c714da7750aaae2](https://git.fellies.net/Citali/cms.fellies.org/commits/637dfd2651a8ad7b0900c0a87c714da7750aaae2))
|
||||
* docs(product): add cms feature topics, package catalog, and inspiration notes ([5b47fafe89e7d1e4fb42646f8bac0e2423828c07](https://git.fellies.net/Citali/cms.fellies.org/commits/5b47fafe89e7d1e4fb42646f8bac0e2423828c07))
|
||||
* docs(versioning): define release policy and close MVP0 pipeline tasks ([516b7730128951a9f0527b89291b21e14e35aca2](https://git.fellies.net/Citali/cms.fellies.org/commits/516b7730128951a9f0527b89291b21e14e35aca2))
|
||||
* chore(ci): add gitea actions runner compose setup ([334a5e35264bf57f1f3586bd78364a5b1d704876](https://git.fellies.net/Citali/cms.fellies.org/commits/334a5e35264bf57f1f3586bd78364a5b1d704876))
|
||||
* chore(repo): remove theoretical workflow and fix prisma ci generation ([a57464d818c10caa2732c1aac113d9a251342de1](https://git.fellies.net/Citali/cms.fellies.org/commits/a57464d818c10caa2732c1aac113d9a251342de1))
|
||||
* chore(repo): update turbo dependency ([37fabad1f8ceb6224c892facb60b5aa2bca02cc5](https://git.fellies.net/Citali/cms.fellies.org/commits/37fabad1f8ceb6224c892facb60b5aa2bca02cc5))
|
||||
* fix(ci): gitea workflows ([c174f840bcfa297937fa40bc3ce4593ddc8ca599](https://git.fellies.net/Citali/cms.fellies.org/commits/c174f840bcfa297937fa40bc3ce4593ddc8ca599))
|
||||
* fix(db): organize imports for biome check ([14c3df623a84a3307d4e825bbf36cccfd882eb49](https://git.fellies.net/Citali/cms.fellies.org/commits/14c3df623a84a3307d4e825bbf36cccfd882eb49))
|
||||
* ci(delivery): add deploy and release workflow scaffolds ([969e88670f5cb3dd0156e4a53bd84d729be4fe82](https://git.fellies.net/Citali/cms.fellies.org/commits/969e88670f5cb3dd0156e4a53bd84d729be4fe82))
|
||||
* ci(gitflow): enforce branch and PR governance checks ([21cc55a1b93f9c7d5ec0db7643f6fe895312a325](https://git.fellies.net/Citali/cms.fellies.org/commits/21cc55a1b93f9c7d5ec0db7643f6fe895312a325))
|
||||
|
||||
## 0.1.0 (2026-02-10)
|
||||
|
||||
### Features
|
||||
|
||||
@@ -46,7 +46,7 @@ Rules:
|
||||
## Changelog Process
|
||||
|
||||
- Keep commit messages conventional.
|
||||
- Generate/update `CHANGELOG.md` with:
|
||||
- Generate/update `CHANGELOG.md` with release-focused sections (includes `Unreleased`):
|
||||
|
||||
```bash
|
||||
bun run changelog:release
|
||||
@@ -57,3 +57,10 @@ bun run changelog:release
|
||||
```bash
|
||||
bun run changelog:preview
|
||||
```
|
||||
|
||||
- For exhaustive output across all allowed commit types (`feat`, `fix`, `docs`, `test`, `ci`, `chore`, `refactor`, etc.):
|
||||
|
||||
```bash
|
||||
bun run changelog:full:preview
|
||||
bun run changelog:full:release
|
||||
```
|
||||
|
||||
@@ -138,7 +138,7 @@ docker compose --env-file .env.gitea-runner -f docker-compose.gitea-runner.yml u
|
||||
|
||||
- Changelog file: `CHANGELOG.md`
|
||||
- Commit schema: Conventional Commits (see `CONTRIBUTING.md`)
|
||||
- Generate/update changelog from git commits:
|
||||
- Generate/update changelog from git commits (release-focused sections + `Unreleased`):
|
||||
|
||||
```bash
|
||||
bun run changelog:release
|
||||
@@ -150,6 +150,13 @@ bun run changelog:release
|
||||
bun run changelog:preview
|
||||
```
|
||||
|
||||
- Generate exhaustive changelog output across all supported commit types:
|
||||
|
||||
```bash
|
||||
bun run changelog:full:preview
|
||||
bun run changelog:full:release
|
||||
```
|
||||
|
||||
## Docs Tool
|
||||
|
||||
- Docs tool: VitePress
|
||||
|
||||
11
TODO.md
11
TODO.md
@@ -197,11 +197,11 @@ This file is the single source of truth for roadmap and delivery progress.
|
||||
|
||||
### Code Documentation And Handover
|
||||
|
||||
- [ ] [P1] Create architecture map per package/app (`what exists`, `why`, `how to extend`) for `@cms/db`, `@cms/content`, `@cms/crud`, `@cms/ui`, `apps/admin`, `apps/web`
|
||||
- [ ] [P1] Add module-level ownership docs for auth, media, pages/navigation, commissions, announcements/news flows
|
||||
- [ ] [P1] Document critical invariants (single owner rule, protected support user, registration policy gates, media storage key contract)
|
||||
- [ ] [P1] Add “request lifecycle” docs for key flows (auth sign-in/up, media upload, page publish, commission status change)
|
||||
- [ ] [P1] Add coding handover playbook: local setup, migration workflow, test strategy, branch/release process, common failure recovery
|
||||
- [x] [P1] Create architecture map per package/app (`what exists`, `why`, `how to extend`) for `@cms/db`, `@cms/content`, `@cms/crud`, `@cms/ui`, `apps/admin`, `apps/web`
|
||||
- [x] [P1] Add module-level ownership docs for auth, media, pages/navigation, commissions, announcements/news flows
|
||||
- [x] [P1] Document critical invariants (single owner rule, protected support user, registration policy gates, media storage key contract)
|
||||
- [x] [P1] Add “request lifecycle” docs for key flows (auth sign-in/up, media upload, page publish, commission status change)
|
||||
- [x] [P1] Add coding handover playbook: local setup, migration workflow, test strategy, branch/release process, common failure recovery
|
||||
- [ ] [P2] Add code-level diagrams (Mermaid) for service boundaries and data relationships
|
||||
- [ ] [P2] Add route/action inventory for admin and public apps with linked source files
|
||||
|
||||
@@ -319,6 +319,7 @@ This file is the single source of truth for roadmap and delivery progress.
|
||||
- [2026-02-12] Admin settings now manage public header banner (enabled/message/CTA), backed by `system_setting` and consumed by public layout rendering.
|
||||
- [2026-02-12] Added owner/support invariant integration tests for auth guards (`apps/admin/src/lib/auth/server.test.ts`), covering protected-user deletion blocking and one-owner repair/promotion rules.
|
||||
- [2026-02-12] Started admin form component tests with media upload behavior coverage (`apps/admin/src/components/media/media-upload-form.test.tsx`).
|
||||
- [2026-02-12] Added code handover documentation baseline: architecture map, critical invariants, request lifecycles, and onboarding playbook under `docs/product-engineering/`.
|
||||
|
||||
## How We Use This File
|
||||
|
||||
|
||||
30
conventional-changelog.config.cjs
Normal file
30
conventional-changelog.config.cjs
Normal file
@@ -0,0 +1,30 @@
|
||||
module.exports = {
|
||||
preset: "conventionalcommits",
|
||||
writerOpts: {
|
||||
transform: (commit) => {
|
||||
const typeMap = {
|
||||
feat: "Features",
|
||||
fix: "Bug Fixes",
|
||||
perf: "Performance",
|
||||
refactor: "Refactors",
|
||||
docs: "Documentation",
|
||||
test: "Tests",
|
||||
build: "Build System",
|
||||
ci: "CI",
|
||||
chore: "Chores",
|
||||
revert: "Reverts",
|
||||
}
|
||||
|
||||
const mappedType = typeMap[commit.type]
|
||||
|
||||
if (!mappedType) {
|
||||
return undefined
|
||||
}
|
||||
|
||||
return {
|
||||
...commit,
|
||||
type: mappedType,
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
@@ -25,6 +25,10 @@ export default defineConfig({
|
||||
{ text: "i18n Baseline", link: "/product-engineering/i18n-baseline" },
|
||||
{ text: "i18n Conventions", link: "/product-engineering/i18n-conventions" },
|
||||
{ text: "RBAC And Permissions", link: "/product-engineering/rbac-permission-model" },
|
||||
{ text: "Code Architecture Map", link: "/product-engineering/code-architecture-map" },
|
||||
{ text: "Critical Invariants", link: "/product-engineering/critical-invariants" },
|
||||
{ text: "Request Lifecycle Flows", link: "/product-engineering/request-lifecycle-flows" },
|
||||
{ text: "Code Handover Playbook", link: "/product-engineering/code-handover-playbook" },
|
||||
{ text: "Domain Glossary", link: "/product-engineering/domain-glossary" },
|
||||
{ text: "Environment Runbook", link: "/product-engineering/environment-runbook" },
|
||||
{ text: "Delivery Pipeline", link: "/product-engineering/delivery-pipeline" },
|
||||
|
||||
53
docs/product-engineering/code-architecture-map.md
Normal file
53
docs/product-engineering/code-architecture-map.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# Code Architecture Map
|
||||
|
||||
This page is the fast handover map for engineers taking over the codebase.
|
||||
|
||||
## Repository Structure
|
||||
|
||||
- `apps/admin`:
|
||||
Next.js admin panel. Owns auth UI, CMS management screens, and protected workflows.
|
||||
- `apps/web`:
|
||||
Next.js public site. Renders CMS-managed content and public-facing routes.
|
||||
- `packages/db`:
|
||||
Prisma schema, generated client usage, and data access services.
|
||||
- `packages/content`:
|
||||
Domain-level Zod schemas and shared contracts.
|
||||
- `packages/crud`:
|
||||
Shared CRUD service pattern (validation, not-found behavior, audit hook contracts).
|
||||
- `packages/ui`:
|
||||
Shared UI primitives used by admin/public apps.
|
||||
- `packages/i18n`:
|
||||
Shared locale helpers.
|
||||
|
||||
## Runtime Boundaries
|
||||
|
||||
- Admin app:
|
||||
writes content and settings, enforces RBAC, runs Better Auth route handlers.
|
||||
- Public app:
|
||||
reads published content and settings; no public auth coupling.
|
||||
- DB package:
|
||||
only data access and business-persistence rules.
|
||||
- Content package:
|
||||
only validation and domain typing; no DB or framework runtime coupling.
|
||||
|
||||
## Core Feature Modules
|
||||
|
||||
- Auth and user guards:
|
||||
`apps/admin/src/lib/auth/server.ts`, `apps/admin/src/app/api/auth/[...all]/route.ts`
|
||||
- Access and route permissions:
|
||||
`apps/admin/src/lib/access.ts`, `apps/admin/src/lib/route-guards.ts`
|
||||
- Media domain + storage:
|
||||
`packages/db/src/media-foundation.ts`, `apps/admin/src/lib/media/storage.ts`
|
||||
- Pages and navigation:
|
||||
`packages/db/src/pages-navigation.ts`, `apps/admin/src/app/pages/*`, `apps/admin/src/app/navigation/*`
|
||||
- Commissions and customers:
|
||||
`packages/db/src/commissions.ts`, `apps/admin/src/app/commissions/page.tsx`
|
||||
- Announcements and news:
|
||||
`packages/db/src/announcements.ts`, `apps/admin/src/app/announcements/page.tsx`, `apps/admin/src/app/news/page.tsx`
|
||||
|
||||
## Extension Rules
|
||||
|
||||
- Add/adjust schema first in `packages/content`.
|
||||
- Implement persistence in `packages/db`.
|
||||
- Wire usage in app route/actions after schema/service are in place.
|
||||
- Add tests at service and app-boundary levels before marking TODO items done.
|
||||
62
docs/product-engineering/code-handover-playbook.md
Normal file
62
docs/product-engineering/code-handover-playbook.md
Normal file
@@ -0,0 +1,62 @@
|
||||
# Code Handover Playbook
|
||||
|
||||
This is the minimum runbook for a new engineer to continue delivery safely.
|
||||
|
||||
## Local Setup
|
||||
|
||||
1. Install Bun matching repo policy.
|
||||
2. Copy `.env.example` to `.env` and fill required values.
|
||||
3. Generate Prisma client:
|
||||
`bun run db:generate`
|
||||
4. Apply migrations:
|
||||
`bun run db:migrate:deploy` (or local named migration flow)
|
||||
5. Seed data:
|
||||
`bun run db:seed`
|
||||
6. Start apps:
|
||||
`bun run dev`
|
||||
|
||||
## Daily Development Loop
|
||||
|
||||
1. Create branch by task type:
|
||||
`todo/*`, `refactor/*`, `code/*`.
|
||||
2. Implement smallest vertical slice for one TODO item.
|
||||
3. Run quality gates:
|
||||
`bun run check`
|
||||
`bun run typecheck`
|
||||
`bun run test`
|
||||
4. Update `TODO.md` status and discovery log.
|
||||
5. Commit with Conventional Commit message and GPG signing.
|
||||
|
||||
## Database Workflow
|
||||
|
||||
- Schema source is:
|
||||
`packages/db/prisma/schema.prisma`
|
||||
- Use named dev migrations for schema changes.
|
||||
- Avoid manual SQL unless migration tooling is blocked.
|
||||
- Always regenerate client after schema change.
|
||||
|
||||
## Testing Strategy
|
||||
|
||||
- Unit/service tests:
|
||||
`packages/*` and logic helpers.
|
||||
- App-boundary integration tests:
|
||||
auth flow and route-level behavior.
|
||||
- E2E tests:
|
||||
full admin/public happy paths through Playwright.
|
||||
|
||||
## Common Failure Recovery
|
||||
|
||||
- `DATABASE_URL not set`:
|
||||
ensure root `.env` is loaded for Bun/Prisma scripts.
|
||||
- Prisma client import errors:
|
||||
run `bun run db:generate`.
|
||||
- Migration drift:
|
||||
run deploy/reset flow in dev and reseed.
|
||||
- Playwright host deps missing:
|
||||
install browser dependencies on host before running e2e.
|
||||
|
||||
## Ownership Expectations
|
||||
|
||||
- Keep invariants explicit and tested before changing auth/media pipelines.
|
||||
- Treat `TODO.md` as delivery source of truth.
|
||||
- If changing branch/release workflow, update docs in same branch.
|
||||
57
docs/product-engineering/critical-invariants.md
Normal file
57
docs/product-engineering/critical-invariants.md
Normal file
@@ -0,0 +1,57 @@
|
||||
# Critical Invariants
|
||||
|
||||
These rules must stay true across refactors and feature work.
|
||||
|
||||
## Auth and User Invariants
|
||||
|
||||
- Exactly one owner user must exist.
|
||||
- The canonical owner must remain protected and not banned.
|
||||
- Support user is system-owned and protected.
|
||||
- Protected users cannot be deleted through auth endpoints.
|
||||
- First owner bootstrap closes open owner-registration window.
|
||||
|
||||
Primary implementation:
|
||||
- `apps/admin/src/lib/auth/server.ts`
|
||||
- `apps/admin/src/app/api/auth/[...all]/route.ts`
|
||||
|
||||
Primary tests:
|
||||
- `apps/admin/src/lib/auth/server.test.ts`
|
||||
- `apps/admin/src/app/register/page.test.tsx`
|
||||
- `apps/admin/src/app/welcome/page.test.tsx`
|
||||
- `apps/admin/src/app/login/page.test.tsx`
|
||||
|
||||
## Registration Policy Invariants
|
||||
|
||||
- If no owner exists:
|
||||
`welcome` flow is open for first owner bootstrap.
|
||||
- If owner exists:
|
||||
self-registration depends on persisted policy in `system_setting`.
|
||||
- Register route must never silently create users when policy is disabled.
|
||||
|
||||
Primary implementation:
|
||||
- `packages/db/src/settings.ts`
|
||||
- `apps/admin/src/app/settings/page.tsx`
|
||||
- `apps/admin/src/app/register/page.tsx`
|
||||
|
||||
## Media Storage Contract
|
||||
|
||||
- Storage provider is selected by `CMS_MEDIA_STORAGE_PROVIDER`.
|
||||
- S3 is primary; local is explicit fallback.
|
||||
- Each media asset stores a stable `storageKey`.
|
||||
- Deleting a media asset must also attempt storage object deletion.
|
||||
|
||||
Primary implementation:
|
||||
- `apps/admin/src/lib/media/storage.ts`
|
||||
- `apps/admin/src/lib/media/storage-key.ts`
|
||||
- `apps/admin/src/app/media/[id]/page.tsx`
|
||||
|
||||
## Public Rendering Contract
|
||||
|
||||
- Public pages must render only published CMS pages.
|
||||
- Public navigation must be built from managed menu items.
|
||||
- Header banner and announcements must be optional and fail-safe.
|
||||
|
||||
Primary implementation:
|
||||
- `apps/web/src/app/[locale]/layout.tsx`
|
||||
- `apps/web/src/app/[locale]/page.tsx`
|
||||
- `apps/web/src/app/[locale]/[slug]/page.tsx`
|
||||
@@ -11,6 +11,10 @@ This section covers platform and implementation documentation for engineers and
|
||||
- [i18n Conventions](/product-engineering/i18n-conventions)
|
||||
- [CRUD Examples](/product-engineering/crud-examples)
|
||||
- [Package Catalog And Decision Notes](/product-engineering/package-catalog)
|
||||
- [Code Architecture Map](/product-engineering/code-architecture-map)
|
||||
- [Critical Invariants](/product-engineering/critical-invariants)
|
||||
- [Request Lifecycle Flows](/product-engineering/request-lifecycle-flows)
|
||||
- [Code Handover Playbook](/product-engineering/code-handover-playbook)
|
||||
- [User Personas And Use-Case Topics](/product-engineering/user-personas-and-use-cases)
|
||||
- [CMS Feature Topics (Domain-Centric)](/product-engineering/cms-feature-topics)
|
||||
- [Domain Glossary](/product-engineering/domain-glossary)
|
||||
|
||||
61
docs/product-engineering/request-lifecycle-flows.md
Normal file
61
docs/product-engineering/request-lifecycle-flows.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# Request Lifecycle Flows
|
||||
|
||||
## 1. Auth Sign-In (Admin)
|
||||
|
||||
1. Browser posts to `/api/auth/sign-in/email`.
|
||||
2. Route resolves `identifier` (email or username) to canonical email.
|
||||
3. Better Auth credential sign-in executes.
|
||||
4. Session cookie is set and user is redirected.
|
||||
|
||||
Key files:
|
||||
- `apps/admin/src/app/login/login-form.tsx`
|
||||
- `apps/admin/src/app/api/auth/[...all]/route.ts`
|
||||
- `apps/admin/src/lib/auth/server.ts`
|
||||
|
||||
## 2. Initial Owner Registration
|
||||
|
||||
1. If no owner exists, `/welcome` renders owner sign-up mode.
|
||||
2. Sign-up request goes through auth route handler.
|
||||
3. New user is promoted to owner in transactional guard.
|
||||
4. Owner invariant is re-validated to enforce single owner.
|
||||
|
||||
Key files:
|
||||
- `apps/admin/src/app/welcome/page.tsx`
|
||||
- `apps/admin/src/app/api/auth/[...all]/route.ts`
|
||||
- `apps/admin/src/lib/auth/server.ts`
|
||||
|
||||
## 3. Media Upload
|
||||
|
||||
1. Admin form posts multipart data to `/api/media/upload`.
|
||||
2. Metadata is validated and file is stored through selected provider.
|
||||
3. Media asset record is persisted with storage metadata.
|
||||
4. UI redirects back to media list with flash status query.
|
||||
|
||||
Key files:
|
||||
- `apps/admin/src/components/media/media-upload-form.tsx`
|
||||
- `apps/admin/src/app/api/media/upload/route.ts`
|
||||
- `apps/admin/src/lib/media/storage.ts`
|
||||
- `packages/db/src/media-foundation.ts`
|
||||
|
||||
## 4. Page Publish
|
||||
|
||||
1. Admin submit on `/pages` calls server action.
|
||||
2. Page schema validates payload and persists.
|
||||
3. `published` status sets publication fields.
|
||||
4. Public app resolves slug and renders page if published.
|
||||
|
||||
Key files:
|
||||
- `apps/admin/src/app/pages/page.tsx`
|
||||
- `packages/db/src/pages-navigation.ts`
|
||||
- `apps/web/src/app/[locale]/[slug]/page.tsx`
|
||||
|
||||
## 5. Commission Status Transition
|
||||
|
||||
1. Admin updates status from commission card form.
|
||||
2. Server action validates transition payload.
|
||||
3. DB update persists new status.
|
||||
4. Kanban view re-renders with updated column placement.
|
||||
|
||||
Key files:
|
||||
- `apps/admin/src/app/commissions/page.tsx`
|
||||
- `packages/db/src/commissions.ts`
|
||||
@@ -23,12 +23,18 @@ Follow `BRANCHING.md`:
|
||||
## Changelog
|
||||
|
||||
- Conventional commits required (see `CONTRIBUTING.md`)
|
||||
- Generate changelog with:
|
||||
- Generate changelog with release-focused sections and `Unreleased`:
|
||||
|
||||
```bash
|
||||
bun run changelog:release
|
||||
```
|
||||
|
||||
- For exhaustive output across all allowed commit types:
|
||||
|
||||
```bash
|
||||
bun run changelog:full:preview
|
||||
```
|
||||
|
||||
## Governance
|
||||
|
||||
- Branch and PR governance checks run in `.gitea/workflows/ci.yml`.
|
||||
|
||||
@@ -23,8 +23,10 @@
|
||||
"test:e2e:headed": "bun run test:e2e:prepare && playwright test --headed",
|
||||
"test:e2e:ui": "bun run test:e2e:prepare && playwright test --ui",
|
||||
"commitlint": "commitlint --last",
|
||||
"changelog:preview": "conventional-changelog -p conventionalcommits -r 0",
|
||||
"changelog:release": "conventional-changelog -p conventionalcommits -i CHANGELOG.md -s",
|
||||
"changelog:preview": "conventional-changelog -p conventionalcommits -r 0 -u",
|
||||
"changelog:release": "conventional-changelog -p conventionalcommits -i CHANGELOG.md -s -u",
|
||||
"changelog:full:preview": "conventional-changelog -n ./conventional-changelog.config.cjs -r 0 -u",
|
||||
"changelog:full:release": "conventional-changelog -n ./conventional-changelog.config.cjs -i CHANGELOG.md -s -u",
|
||||
"lint": "turbo lint",
|
||||
"typecheck": "turbo typecheck",
|
||||
"format": "biome format --write .",
|
||||
|
||||
Reference in New Issue
Block a user