Zum Inhalt springen

Schuly-Dokumentation

Schuly ist eine Flutter-App für den mobilen Zugriff auf Schuldaten (Noten, Prüfungen, Stundenplan, Absenzen) von Schulnetz-basierten Systemen. Sie läuft in zwei Modi - einem Account-Modus, der über SchulyBackend per OIDC läuft, und einem privaten / sicheren Modus, der die Zugangsdaten auf dem Gerät behält und nur mit anonymen, zustandslosen Proxy-Endpunkten kommuniziert. Das UI ist mit Forui gebaut.

Inhalt

DokumentInhalt
Architektur: App-ModiAccount- vs. privater Modus, wo die Daten liegen, der Verbindungsablauf
EntwicklungsumgebungFlutter SDK, bun-Task-Runner, Ausführen der Dev-/Prod-Flavors, analyze/test/format
Build & ReleaseRelease-APKs, iOS-Build, adb-Installation, Neugenerierung des App-Icons
API-ClientWie lib/api/ generiert wird und wie man es neu generiert
ContributingDer verbindliche Issue-→-Branch-→-PR-Workflow und die Label-Taxonomie

Schnellstart

sh
bun run clean   # flutter clean && flutter pub get
bun run dev     # Dev-Flavor auf einem verbundenen Gerät/Emulator ausführen

Voraussetzungen findest du unter Entwicklungsumgebung.