SHA256

No description

TypeScript 99%
Dockerfile 1%

Find a file

Robin Franke 8cccfbd54e docs(backend): API-Module und Umgebungsvariablen dokumentiert - Neue Tabelle mit allen Umgebungsvariablen - Auth/ACL/Crypto/Audit-Konventionen detailliert - Swagger-UI unter /docs erwähnt - ENCRYPTION_KEY-Format dokumentiert		2026-06-10 10:55:28 +02:00
backend	docs(backend): API-Module und Umgebungsvariablen dokumentiert	2026-06-10 10:55:28 +02:00
docs	docs(design): API-Pfad-Naming auf Englisch korrigiert	2026-06-10 10:42:30 +02:00
frontend	docs(frontend): OpenAPI-Typgenerierung dokumentiert	2026-06-10 10:43:15 +02:00
keycloak	chore(repo): initiales Monorepo-Setup mit Ordnerstruktur und Konventionen	2026-06-09 20:02:25 +02:00
.gitignore	chore(repo): initiales Monorepo-Setup mit Ordnerstruktur und Konventionen	2026-06-09 20:02:25 +02:00
AGENTS.md	docs(root): API-Pfad-Naming-Regel in AGENTS.md definiert	2026-06-10 10:42:44 +02:00
docker-compose.yml	fix(keycloak): KEYCLOAK_ADMIN durch KC_BOOTSTRAP_ADMIN_USERNAME ersetzt	2026-06-09 21:48:17 +02:00
openapi.yaml	feat(api): gemeinsame openapi.yaml als Single Source of Truth	2026-06-10 10:42:10 +02:00
README.md	docs(readme): openapi.yaml in Projektstruktur aufgenommen	2026-06-10 10:43:32 +02:00

README.md

FamilienFeierPlaner

Personen-, Kontakt- und Event-Management-System (Gästeliste & Zahlungsabgleich).

Architektur

Frontend — Cloudflare Worker (BFF) + UI-Framework
Backend — Node.js (Fastify) REST API
Datenbank — PostgreSQL mit AES-256-GCM-Verschlüsselung
Auth — Keycloak (OAuth2 / PKCE)

Verzeichnisstruktur

├── openapi.yaml    OpenAPI 3.1-Spezifikation (Single Source of Truth)
├── frontend/       Cloudflare Worker (BFF) + UI
├── backend/        Fastify REST API + Prisma
├── keycloak/       Keycloak-Realm-Export + Custom Theme
└── docs/           Technische Spezifikationen

Erste Schritte

Voraussetzungen: Docker & Docker Compose

# Backend-Abhängigkeiten installieren (für lokale TypeScript-Entwicklung)
cd backend && npm install

# Vollen Stack starten
docker compose up --build

Damit werden gestartet:

PostgreSQL (Port 5432) — relationale Datenbank
Keycloak (Port 8080, Admin: admin / admin) — Authentifizierung
Fastify-Backend (Port 3000) — REST API

Health-Check prüfen:

curl http://localhost:3000/health
# {"status":"ok","database":"connected","keycloak":"reachable"}

Fahrplan

Das Projekt wird in 12 Meilensteinen entwickelt (Details im Designdokument):

MS	Titel	Status
1	Initiales Repository & Ordnerstruktur	✅
2	Infrastruktur-Skelett & `/health`-Integration	✅
3	Datenbankschema & Automatisches Seeding	✅
4	API-Kern (REST-Infrastruktur)	in Arbeit
5	Testabdeckung & Integrität
6	Keycloak & Wartungsoperationen
7	Import & Rechnung
8	Datenschutz-Dokumente & DSGVO-Sperre
9	BFF-Skelett & Konnektivitätstest
10	API-Playground
11	Authentifizierung (Keycloak)
12	Vollständige UI (ausstehend)

Technisches Design

→ docs/design.md

API-Spezifikation

Die gesamte REST-API ist als OpenAPI 3.1-Spezifikation dokumentiert:

→ openapi.yaml

Konventionen

→ AGENTS.md