19855efacc
Some checks failed
Tests / Go Tests (push) Has been cancelled
Tests / Python Tests (push) Has been cancelled
Tests / Integration Tests (push) Has been cancelled
Tests / Go Lint (push) Has been cancelled
Tests / Python Lint (push) Has been cancelled
Tests / Security Scan (push) Has been cancelled
Tests / All Checks Passed (push) Has been cancelled
Security Scanning / Secret Scanning (push) Has been cancelled
Security Scanning / Dependency Vulnerability Scan (push) Has been cancelled
Security Scanning / Go Security Scan (push) Has been cancelled
Security Scanning / Python Security Scan (push) Has been cancelled
Security Scanning / Node.js Security Scan (push) Has been cancelled
Security Scanning / Docker Image Security (push) Has been cancelled
Security Scanning / Security Summary (push) Has been cancelled
CI/CD Pipeline / Go Tests (push) Has been cancelled
CI/CD Pipeline / Python Tests (push) Has been cancelled
CI/CD Pipeline / Website Tests (push) Has been cancelled
CI/CD Pipeline / Linting (push) Has been cancelled
CI/CD Pipeline / Security Scan (push) Has been cancelled
CI/CD Pipeline / Docker Build & Push (push) Has been cancelled
CI/CD Pipeline / Integration Tests (push) Has been cancelled
CI/CD Pipeline / Deploy to Staging (push) Has been cancelled
CI/CD Pipeline / Deploy to Production (push) Has been cancelled
CI/CD Pipeline / CI Summary (push) Has been cancelled
ci/woodpecker/manual/build-ci-image Pipeline was successful
ci/woodpecker/manual/main Pipeline failed
All services: admin-v2, studio-v2, website, ai-compliance-sdk, consent-service, klausur-service, voice-service, and infrastructure. Large PDFs and compiled binaries excluded via .gitignore.
3.8 KiB
3.8 KiB
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
-
:material-rocket-launch:{ .lg .middle } Erste Schritte
Entwicklungsumgebung einrichten und das Projekt starten.
-
:material-server:{ .lg .middle } Mac Mini Setup
Headless Server-Konfiguration fuer den Entwicklungsserver.
Architektur
-
:material-sitemap:{ .lg .middle } System-Architektur
Ueberblick ueber alle Komponenten und deren Zusammenspiel.
-
:material-shield-lock:{ .lg .middle } Auth-System
Hybrid-Authentifizierung mit Keycloak und lokalem JWT.
-
:material-robot:{ .lg .middle } Multi-Agent System
Verteilte Agent-Architektur fuer KI-Funktionen.
-
:material-key-chain:{ .lg .middle } Secrets Management
HashiCorp Vault Integration fuer sichere Credentials.
Services
| Service | Port | Beschreibung |
|---|---|---|
| Backend (Python) | 8000 | FastAPI Backend mit Panel UI |
| Consent Service (Go) | 8081 | DSGVO-konforme Einwilligungsverwaltung |
| Klausur Service | 8086 | KI-gestuetzte Klausurkorrektur |
| Agent Core | - | Multi-Agent Infrastructure |
| PostgreSQL | 5432 | Relationale Datenbank |
| Qdrant | 6333 | Vektor-Datenbank fuer RAG |
| MinIO | 9000 | Object Storage |
| Vault | 8200 | Secrets Management |
Entwicklung
- Testing - Test-Standards und Ausfuehrung
- Dokumentation - Dokumentations-Richtlinien
- DevSecOps - Security Pipeline
- Umgebungen - Dev/Staging/Prod
Weitere Ressourcen
- GitHub Repository: Internes GitLab
- Issue Tracker: GitLab Issues
- API Playground: 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:
- Pruefen Sie zuerst die relevante Dokumentation
- Suchen Sie im Issue Tracker nach aehnlichen Problemen
- Erstellen Sie ein neues Issue mit detaillierter Beschreibung