Schuly documentation
Schuly is a Flutter mobile app for accessing school data (grades, exams, agenda, absences) from Schulnetz-based systems. It runs in two modes — an account mode backed by SchulyBackend over OIDC, and a private / secure mode that keeps credentials on-device and talks only to anonymous stateless proxy endpoints. The UI is built with Forui.
Contents
| Doc | What it covers |
|---|---|
| Architecture: app modes | Account vs private mode, where data lives, the connect flow |
| Development setup | Flutter SDK, bun task runner, running the dev/prod flavors, analyze/test/format |
| Build & release | Release APKs, iOS build, adb install, app-icon regeneration |
| API client | How lib/api/ is generated and how to regenerate it |
| Contributing | The enforced issue → branch → PR workflow and label taxonomy |
Quick start
bun run clean # flutter clean && flutter pub get
bun run dev # run the dev flavor on a connected device/emulator
See Development setup for prerequisites.