docs: README im Root, Backend/Frontend-READMEs, Statuszeilen (2026-10-16)
Neues README im Root mit Zweck, Aufbau, Start, Prüfbefehlen, Betrieb und Projektstand (Issues #44, #43). Backend- und Frontend-README ersetzen die Framework-Vorlagen. CLAUDE.md: Ordnerstruktur und echte Arbeitsweise (main, gebündelt pushen, Rollout nur mit Freigabe). ARCHITECTURE §7/§8: Live-ConfigMap, ensure-secrets.sh, korrektes Admin-Seed-Verhalten. .env.example um BACKUP_MAX_IMPORT_BYTES und SEED_ADMIN_* ergänzt. Statuszeilen in Plänen Rückgrat, T3–T6 und Specs Fahrplan, T7. Refs #42 Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
This commit is contained in:
1 parent
b48fb157c8
commit
ec8c95056d
15 files changed
+194
-125
No files matched your search
@@ -1,21 +1,26 @@
|
||||
# ApiCore – Projektkontext für Claude Code
|
||||
|
||||
Digitale Imkereiverwaltung für Wabenhain. Fachliche Quelle der Wahrheit: [`docs/lastenheft.md`](docs/lastenheft.md). Architektur- und Modulschnitt: [`ARCHITECTURE.md`](ARCHITECTURE.md). Fortschritt/Aufgaben: [`TASKS.md`](TASKS.md).
|
||||
Digitale Imkereiverwaltung für Wabenhain. Fachliche Quelle der Wahrheit: [`docs/lastenheft.md`](docs/lastenheft.md). Architektur- und Modulschnitt: [`ARCHITECTURE.md`](ARCHITECTURE.md). Fortschritt/Aufgaben: [`TASKS.md`](TASKS.md). Projektstand, offene Punkte und Inhaber-Aufgaben: Gitea-Issues, Einstieg über das Übersichts-Issue (verlinkt in [`README.md`](README.md)).
|
||||
|
||||
## Ordnerstruktur
|
||||
|
||||
```
|
||||
ApiCore/
|
||||
├── README.md Einstieg: Zweck, Start, Prüfen, Betrieb, Doku-Landkarte, Projektstand
|
||||
├── docs/lastenheft.md Fachliches Lastenheft (verbindlich)
|
||||
├── docs/pruefung-2026-09.md Prüfberichte, Sicherheitsaudit, Bestandsbuch, AuDHD-Regeln
|
||||
├── docs/erp-inventar-export.md Vertrag der Schnittstelle zu ERPNext
|
||||
├── docs/superpowers/ specs/ (Designs je Teilprojekt) und plans/ (Umsetzungspläne mit Tasks, Rollout-Runbook)
|
||||
├── ApiCore-Backend/ NestJS API (TypeScript, Prisma, PostgreSQL)
|
||||
├── ApiCore-Frontend/ Next.js App Router (TypeScript, Tailwind, shadcn/ui)
|
||||
├── deploy/k8s/ Kubernetes-Manifeste (Deployment, Service, Ingress, ConfigMap/Secret-Vorlagen)
|
||||
├── deploy/k8s/ Kustomize: base/, components/, overlays/encry/, tests/, scripts/ (ARCHITECTURE.md Abschnitt 7)
|
||||
├── .gitea/workflows/ CI: Backend-Image, Frontend-Image, Manifest-Prüfung
|
||||
├── CLAUDE.md Diese Datei
|
||||
├── ARCHITECTURE.md Modulschnitt, Auth-Flow, Entscheidungen/Abweichungen
|
||||
└── TASKS.md Abhakbare Aufgabenliste (MVP / v1.x / Später)
|
||||
├── ARCHITECTURE.md Modulschnitt, Auth-Flow, Entscheidungen/Abweichungen, Annahmen
|
||||
└── TASKS.md Abhakbare Aufgabenliste (MVP / v1.x / Später / Fahrplan T3–T7 / Beute)
|
||||
```
|
||||
|
||||
Ein Git-Repo für beide Projekte gemeinsam, Root ist `ApiCore/`. Feature-Branches pro Modul, siehe TASKS.md.
|
||||
Ein Git-Repo für beide Projekte gemeinsam, Root ist `ApiCore/`. Gearbeitet wird direkt auf `main`; größere Vorhaben bekommen vorher eine Spec und einen Plan unter `docs/superpowers/`. Commits werden gebündelt gepusht, weil jeder Push auf `main` die Image-Builds startet. Ausrollen ins Cluster nur mit Freigabe des Inhabers.
|
||||
|
||||
## Tech-Stack
|
||||
|
||||
@@ -34,7 +39,7 @@ Voraussetzung Backend: laufende PostgreSQL-Instanz, `.env` mit `DATABASE_URL` (s
|
||||
cd ApiCore-Backend
|
||||
npm install
|
||||
npx prisma migrate dev # Schema anwenden
|
||||
npm run start:dev # http://localhost:3001, Swagger unter /api/v1/docs
|
||||
npm run start:dev # http://localhost:3001, Swagger unter /api/v1/docs nur mit ENABLE_SWAGGER=true
|
||||
|
||||
# Frontend
|
||||
cd ApiCore-Frontend
|
||||
|
||||
Reference in new issue
Block a user