60 lines
3.1 KiB
Markdown
60 lines
3.1 KiB
Markdown
# desktop.kusche.berlin
|
|
|
|
Zentraler Dokumentationsindex fuer das Projekt.
|
|
|
|
## Zentrale Dateien
|
|
|
|
- [CONTENT.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/CONTENT.md)
|
|
Zentrale Inhaltsbasis mit offiziellen Begriffen, Systemumfang und spaeterer Hilfe-Basis.
|
|
|
|
- [ANLEITUNG.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/ANLEITUNG.md)
|
|
Nutzungs- und Hilfedatei fuer Bedienung, Orientierung und spaetere Hilfebereiche.
|
|
|
|
- [WEITERENTWICKLUNG.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/WEITERENTWICKLUNG.md)
|
|
Regeln fuer Weiterentwicklung, Doku-Pflege, Go's und NoGo's.
|
|
|
|
- [UMSETZUNGSSTATUS.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/UMSETZUNGSSTATUS.md)
|
|
Laufender Umsetzungsstatus mit Abnahmeregel und Nachweisen.
|
|
|
|
- [Umsetzungsanweisung/START_HIER.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/Umsetzungsanweisung/START_HIER.md)
|
|
Einstieg in die fachlichen Umsetzungsanweisungen und deren Reihenfolge.
|
|
|
|
## Technische Projektstruktur
|
|
|
|
- `public/` Web-Root mit Desktop-Shell auf `/`
|
|
- `src/Desktop/` zentrale Desktop-Mechaniken
|
|
- `src/ModulesCore/` gemeinsame Helfer fuer Modul-Discovery, Modul-HTTP und wiederverwendbare Modul-Anbindung
|
|
- `partials/desktop/` Shell-Template
|
|
- `modules/` Zielort fuer klassische Module
|
|
- `temp/nexus-module-import/` Rohbasis fuer importierte Nexus-Module
|
|
|
|
## Fachliche Hinweise
|
|
|
|
- `Old-Nexus/` wird nicht technisch eingebunden.
|
|
- Skins `Windows`, `Apple`, `Linux` laufen auf einer gemeinsamen Shell.
|
|
- Keycloak bleibt das Auth-System.
|
|
- API und Desktop laufen auf demselben Host. Zielpfad ist `(staging.)desktop.kusche.berlin/api/v1/...`.
|
|
- der Theme-Handoff ist in [keycloak-theme-handoff.md](/home/lars/Schreibtisch/Projekte/desktop.kusche.berlin/docs/keycloak-theme-handoff.md) beschrieben.
|
|
- das globale Admin-Debugging ist Teil der Desktop-Shell und wird nicht pro App als eigene Grundfunktion dupliziert
|
|
|
|
## Dokumentationsregel
|
|
|
|
Wichtige Informationen duerfen nicht nur in Unterordnern oder Einzeldateien stehen.
|
|
|
|
Es gilt:
|
|
|
|
- wichtige Inhalte aus Unterordner-`README.md`-Dateien werden zentral in `docs/CONTENT.md` gespiegelt
|
|
- Nutzungswissen wird in `docs/ANLEITUNG.md` gepflegt
|
|
- Entwicklungsregeln werden in `docs/WEITERENTWICKLUNG.md` gepflegt
|
|
|
|
Aktuell wichtig:
|
|
|
|
- der Mining-Checker ist das erste als echtes Desktop-Modul angebundene Modul unter `modules/mining-checker/`
|
|
- der Waehrungs-Checker ist als zweites echtes Desktop-Modul unter `modules/fx-rates/` angebunden
|
|
- der Salesforce Translation Import ist als weitere Desktop-App unter `modules/salesforce-translation-import/` angebunden
|
|
- Modul-Assets koennen ueber einen gemeinsamen Auslieferungsweg aus dem Modul selbst geladen werden
|
|
- die API bleibt vorerst auf demselben Host und wird nicht auf `api.desktop.kusche.berlin` ausgelagert
|
|
- das gemeinsame Admin-Debug-Widget neben der Uhr ist der Standard fuer Live-Debugging in Desktop und Native-Apps
|
|
- der Waehrungs-Checker stellt zusaetzlich ein Desktop-Widget fuer manuelle Kursaktualisierung bereit
|
|
- das Oeffnen des Waehrungs-Checkers darf keinen externen Kursabruf ausloesen; Refreshes laufen nur nach Altersregel oder mit `force`
|