21a844cb8a
A previous `git pull --rebase origin main` dropped 177 local commits,
losing 3400+ files across admin-v2, backend, studio-v2, website,
klausur-service, and many other services. The partial restore attempt
(660295e2) only recovered some files.
This commit restores all missing files from pre-rebase ref 98933f5e
while preserving post-rebase additions (night-scheduler, night-mode UI,
NightModeWidget dashboard integration).
Restored features include:
- AI Module Sidebar (FAB), OCR Labeling, OCR Compare
- GPU Dashboard, RAG Pipeline, Magic Help
- Klausur-Korrektur (8 files), Abitur-Archiv (5+ files)
- Companion, Zeugnisse-Crawler, Screen Flow
- Full backend, studio-v2, website, klausur-service
- All compliance SDKs, agent-core, voice-service
- CI/CD configs, documentation, scripts
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
125 lines
3.8 KiB
Markdown
125 lines
3.8 KiB
Markdown
# Breakpilot Dokumentation
|
|
|
|
Willkommen zur zentralen Dokumentation des Breakpilot-Projekts.
|
|
|
|
## Was ist Breakpilot?
|
|
|
|
Breakpilot ist eine DSGVO-konforme Bildungsplattform fuer Lehrkraefte mit folgenden Kernfunktionen:
|
|
|
|
- **Consent-Management** - Datenschutzkonforme Einwilligungsverwaltung
|
|
- **KI-gestuetzte Klausurkorrektur** - Automatische Bewertungsvorschlaege fuer Abiturklausuren
|
|
- **Zeugnisgenerierung** - Workflow-basierte Zeugniserstellung mit Rollenkonzept
|
|
- **Lernmaterial-Generator** - MC-Tests, Lueckentexte, Mindmaps, Quiz
|
|
- **Elternbriefe** - GFK-basierte Kommunikation mit PDF-Export
|
|
|
|
## Schnellstart
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :material-rocket-launch:{ .lg .middle } **Erste Schritte**
|
|
|
|
---
|
|
|
|
Entwicklungsumgebung einrichten und das Projekt starten.
|
|
|
|
[:octicons-arrow-right-24: Umgebung einrichten](getting-started/environment-setup.md)
|
|
|
|
- :material-server:{ .lg .middle } **Mac Mini Setup**
|
|
|
|
---
|
|
|
|
Headless Server-Konfiguration fuer den Entwicklungsserver.
|
|
|
|
[:octicons-arrow-right-24: Mac Mini Setup](getting-started/mac-mini-setup.md)
|
|
|
|
</div>
|
|
|
|
## Architektur
|
|
|
|
<div class="grid cards" markdown>
|
|
|
|
- :material-sitemap:{ .lg .middle } **System-Architektur**
|
|
|
|
---
|
|
|
|
Ueberblick ueber alle Komponenten und deren Zusammenspiel.
|
|
|
|
[:octicons-arrow-right-24: Architektur](architecture/system-architecture.md)
|
|
|
|
- :material-shield-lock:{ .lg .middle } **Auth-System**
|
|
|
|
---
|
|
|
|
Hybrid-Authentifizierung mit Keycloak und lokalem JWT.
|
|
|
|
[:octicons-arrow-right-24: Auth-System](architecture/auth-system.md)
|
|
|
|
- :material-robot:{ .lg .middle } **Multi-Agent System**
|
|
|
|
---
|
|
|
|
Verteilte Agent-Architektur fuer KI-Funktionen.
|
|
|
|
[:octicons-arrow-right-24: Multi-Agent](architecture/multi-agent.md)
|
|
|
|
- :material-key-chain:{ .lg .middle } **Secrets Management**
|
|
|
|
---
|
|
|
|
HashiCorp Vault Integration fuer sichere Credentials.
|
|
|
|
[:octicons-arrow-right-24: Secrets](architecture/secrets-management.md)
|
|
|
|
</div>
|
|
|
|
## Services
|
|
|
|
| Service | Port | Beschreibung |
|
|
|---------|------|--------------|
|
|
| [Backend (Python)](api/backend-api.md) | 8000 | FastAPI Backend mit Panel UI |
|
|
| [Consent Service (Go)](architecture/auth-system.md) | 8081 | DSGVO-konforme Einwilligungsverwaltung |
|
|
| [Klausur Service](services/klausur-service/index.md) | 8086 | KI-gestuetzte Klausurkorrektur |
|
|
| [Agent Core](services/agent-core/index.md) | - | Multi-Agent Infrastructure |
|
|
| PostgreSQL | 5432 | Relationale Datenbank |
|
|
| Qdrant | 6333 | Vektor-Datenbank fuer RAG |
|
|
| MinIO | 9000 | Object Storage |
|
|
| Vault | 8200 | Secrets Management |
|
|
|
|
## Entwicklung
|
|
|
|
- [Testing](development/testing.md) - Test-Standards und Ausfuehrung
|
|
- [Dokumentation](development/documentation.md) - Dokumentations-Richtlinien
|
|
- [DevSecOps](architecture/devsecops.md) - Security Pipeline
|
|
- [Umgebungen](architecture/environments.md) - Dev/Staging/Prod
|
|
|
|
## Weitere Ressourcen
|
|
|
|
- **GitHub Repository**: Internes GitLab
|
|
- **Issue Tracker**: GitLab Issues
|
|
- **API Playground**: [http://macmini:8000/docs](http://macmini:8000/docs)
|
|
|
|
---
|
|
|
|
## Projektstruktur
|
|
|
|
```
|
|
breakpilot-pwa/
|
|
├── backend/ # Python FastAPI Backend
|
|
├── consent-service/ # Go Consent Service
|
|
├── klausur-service/ # Klausur-Korrektur Service
|
|
├── agent-core/ # Multi-Agent Infrastructure
|
|
├── voice-service/ # Voice/Audio Processing
|
|
├── website/ # Next.js Frontend
|
|
├── studio-v2/ # Admin Dashboard (Next.js)
|
|
├── docs-src/ # Diese Dokumentation
|
|
└── docker-compose.yml # Container-Orchestrierung
|
|
```
|
|
|
|
## Support
|
|
|
|
Bei Fragen oder Problemen:
|
|
|
|
1. Pruefen Sie zuerst die relevante Dokumentation
|
|
2. Suchen Sie im Issue Tracker nach aehnlichen Problemen
|
|
3. Erstellen Sie ein neues Issue mit detaillierter Beschreibung
|