Schuly documentation
Use these pages to run, build, and change the Schuly mobile app. Schuly is a Flutter app for Android and iOS that shows grades, exams, agenda, and absences from school systems. The UI uses Forui.
The app runs in two modes:
- Account mode: uses a Schuly account on SchulyServer.
- Private mode (also called secure mode): keeps credentials on the device and calls anonymous, stateless proxy endpoints.
Quick start
sh
bun run clean # flutter clean && flutter pub get
bun run dev # run the dev flavor on a connected device or emulatorDevelopment setup lists the prerequisites.
Pages
| Page | What it covers |
|---|---|
| App modes | Account and private mode, where data lives, the connect flow |
| Development setup | Prerequisites, bun tasks, flavors, local backend, quality checks |
| Build and release | Local builds, adb install, app icons, the release workflow |
| API client | How lib/api/ is generated and how to regenerate it |
| Contributing | This repo's rules and checks |
