Entwicklerdokumentation

Entwicklerdokumentation

Dieser Bereich richtet sich an alle, die hocX betreiben, weiterentwickeln oder technisch verstehen möchten.

Grundlagen

Thema	Inhalt
Architektur	Stack, Services, Multi-Tenancy und Snapshot-Prinzip
Big Picture	Container, Datenflüsse, Domains und Zugriffsgrenzen
Entwickler-Onboarding	Vom Checkout bis zur ersten getesteten Änderung
Code-Architektur	Backend-Schichten, Frontend, Kollaboration und Datenflüsse
API-Konventionen	Verträge, Auth, IDs, Fehler und Pagination
Datenbank und Migrationen	Alembic, Rollen und sichere Schemaänderungen
Platform-Admin-Panel	Mandantenübergreifende Betreiberoberfläche
Mandanten-Export und -Import	Portabler Transfer von Vereinsdaten

Betrieb und Qualität

Thema	Inhalt
Testprozess	Backend, Frontend, E2E, CI und Release-Verifikation
Deployment-Runbook	Candidate-Build, Test, Promotion, Produktion, Rollback, Provisionierung und Backups
Konfiguration	Env-Variablen, Secrets und Umgebungsunterschiede
Debugging und Observability	Logs, Healthchecks und Fehlersuche
Beitragen und Qualität	Branches, Pull Requests, Reviews und Definition of Done
Dokumentationspflege	Führende Quelle und Aktualisierungsregeln
Sicherheit	Sicherheitsmodell, Schutzmassnahmen und Audit-Historie
Bekannte offene Punkte	Technische Schulden und bereits erledigte Punkte

Quellcode-Struktur

frontend/              Hauptanwendung und Platform-Admin-UI
backend/               API, Geschäftslogik und Alembic-Migrationen
abgabebox-frontend/    öffentliche Upload-Oberfläche
abgabebox-backend/     eingeschränkte API der Abgabebox
docs-site/             separate MkDocs-Benutzer-/Legacy-Dokumentation
infra/traefik/         Traefik-Konfiguration
scripts/               Entwicklung, Deployment, Backups und Verifikation
storage/               lokale Uploads, Exporte und Dokumentvorlagen

Für den lokalen Einstieg und die vollständigen Befehle siehe die README im Hauptrepository.