Files
LektorenPlan/README.md
T

141 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# LektorenPlan
macOS-SwiftUI-Prototyp für die Planung von Lektorinnen, Lektoren und
Kommunionhelferinnen/-helfern in der Pfarreiengemeinschaft Bad Godesberg
(St. Andreas, St. Evergislus, Herz Jesu, St. Hildegard).
Das ausführliche Grobkonzept liegt in [CONCEPT.md](CONCEPT.md).
## Webversion
Unter [`web/`](web/) liegt eine funktional entsprechende Browserfassung in Go
mit SQLite, Mehrbenutzerbetrieb und Mandantentrennung. Sie ist CGO-frei und
lässt sich für Linux/arm64 bauen; die macOS-App bleibt unverändert.
```bash
cd web
go run . -seed-demo -demo
# → http://localhost:8080, Demo-Zugänge: admin/admin123, editor/editor123, reader/reader123
```
Details zu Betrieb, Rollen, Deployment und Sicherheit stehen in
[web/README.md](web/README.md).
## Voraussetzungen
- macOS 14 oder neuer
- Xcode 15 oder neuer bzw. Swift 5.9+
- Keine externen Abhängigkeiten
## Bauen und starten
```bash
# Debug-Build und Tests
swift build
swift test
# App-Bundle erzeugen und öffnen
./Scripts/build-app.sh debug
open build/LektorenPlan.app
```
Alternativ `Package.swift` in Xcode öffnen und das Schema `LektorenPlan`
starten.
Die App legt ihre Datenbank unter
`~/Library/Application Support/LektorenPlan/lektorenplan.sqlite` an und befüllt
sie beim ersten Start mit Demo-Daten. Über **Einstellungen → Demo-Daten
zurücksetzen** lässt sich der Ausgangszustand wiederherstellen; **Alle Daten
löschen** entfernt den kompletten Bestand und verhindert, dass die Demo-Daten
beim nächsten Start automatisch wieder angelegt werden.
## Funktionsüberblick
- **Kalender & Planung:** Tageszeilen mit Liturgie, Lesungen und Gottesdiensten
der vier Kirchen; Sonntage, Hochfeste und gebotene Feiertage hervorgehoben.
- **Zeitstrahl:** frei wählbarer Zeitraum mit Griffen und Marken für Quartale,
Osterzeit, Weihnachtszeit und Kirchenjahr.
- **Automatische Planung:** harte Ausschlüsse (Rolle, Abwesenheit, Monatslimit,
Doppelbelegung, Einsatztag) und weiche Präferenzen (Kirche, Gottesdienst,
Wochentag, Fairness).
- **Manuelle Nachsteuerung:** Kandidatenvorschläge mit Warnhinweisen,
Einsätze sperren oder entfernen.
- **Gottesdienstordnung:** wiederkehrende Vorlagen, Ausnahmen und
Sondergottesdienste. Sondergottesdienste können statt einer Kirche einen
freien Ort (z. B. Open-Air) tragen.
- **Team:** Personen, Rollen, Präferenzen, Abwesenheiten, Monatslimits.
- **Statistik:** Besetzungsquote, Fairness, Monatsverlauf, Kirchenverteilung,
Präferenztreffer, Einsatzübersicht (Swift Charts).
- **Austausch:** JSON-Export und -Import für Planungsabschnitte oder Ressourcen
mit Vorschau vor dem Zusammenführen.
- **PDF & Druck:** zwei Varianten – A4 quer mit Kirchenspalten, Lesungen und
automatischer Pagination sowie eine kompakte A4-hoch-Liste mit einer Zeile
pro Gottesdienst (Kirche/Ort, Uhrzeit, Nachnamen von Lektoren und
Kommunionhelfern). Beide mit PDFKit-Vorschau, Sichern und direkter Druck.
## Liturgische Daten
Die App nutzt den liturgischen Kalender für das Erzbistum Köln über
[www.eucharistiefeier.de](https://www.eucharistiefeier.de). Für 2025–2028 ist
ein Offline-Snapshot enthalten; der aktuelle Jahrgang kann in den Einstellungen
oder über die Kalender-Schaltfläche online aktualisiert werden.
> Daten von www.eucharistiefeier.de – fair use, ausschließlich zur Anzeige.
> Die Daten bleiben Eigentum der Quelle.
## Projektstruktur
```
Sources/
├── LektorenPlanCore/ Modelle, SQLite, Liturgie, Planer, Statistik
├── LektorenPlan/ SwiftUI-App, Views, Sheets, PDF-Renderer
Tests/LektorenPlanCoreTests/
Resources/AppIcon.icns App-Icon
Scripts/build-app.sh erzeugt build/LektorenPlan.app
Scripts/make-icon.swift erzeugt Resources/AppIcon.icns
CONCEPT.md Grobkonzept
```
## App-Icon
Das Icon zeigt eine Kirche als Linienzeichnung im Hintergrund und eine
stilisierte Kalenderkarte im Vordergrund. Es wird per Skript als
ICNS-Datei erzeugt und beim Bauen ins App-Bundle kopiert:
```bash
swift Scripts/make-icon.swift
./Scripts/build-app.sh debug
```
Die Vorschau in voller Auflösung landet unter `build/AppIcon-1024.png`.
## Entwicklungshelfer
Für visuelle Prüfungen ohne Bildschirmaufnahme-Berechtigung kann die App eine
Ansicht als PNG rendern und/oder den Plan als PDF schreiben:
```bash
BIN=$(swift build --show-bin-path)
LP_SNAPSHOT=/tmp/plan.png "$BIN/LektorenPlan"
LP_SNAPSHOT=/tmp/statistik.png LP_SNAPSHOT_VIEW=statistics \
LP_SNAPSHOT_HEIGHT=2000 "$BIN/LektorenPlan"
LP_PDF=/tmp/plan.pdf "$BIN/LektorenPlan"
LP_PDF=/tmp/liste.pdf LP_PDF_VARIANT=compact "$BIN/LektorenPlan"
```
`LP_PDF_VARIANT=compact` erzeugt die reduzierte A4-hoch-Liste. Mit
`LP_RESET_DEMO=/tmp/report.txt` (optional `LP_RESET_MODE=delete` oder `none`)
lässt sich der Datenbank-Neuaufbau automatisiert prüfen; die App schreibt
anschließend die Datensatzanzahl in die Report-Datei.
`LP_SNAPSHOT_VIEW` akzeptiert `planning`, `root`, `team`, `order`,
`statistics`, `exchange` und `settings`. Der Auto-Sync ist bei
Snapshot-Läufen deaktiviert.
## Status
Version 0.9. Die Demo-Personen und Kontaktdaten sind fiktiv. Produktive
Aspekte wie Benutzerkonten, Benachrichtigungen, Signierung und ein
Mehrbenutzerbetrieb sind noch nicht umgesetzt; siehe Abschnitt „Grenzen“ in
[CONCEPT.md](CONCEPT.md).