Skip to content

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 emulator

Development setup lists the prerequisites.

Pages ​

PageWhat it covers
App modesAccount and private mode, where data lives, the connect flow
Development setupPrerequisites, bun tasks, flavors, local backend, quality checks
Build and releaseLocal builds, adb install, app icons, the release workflow
API clientHow lib/api/ is generated and how to regenerate it
ContributingThis repo's rules and checks