Getting Started

Set up the native Flutter application and run the same validation gates used by CI.

Prerequisites

• Flutter version pinned in .github/flutter-version
• Dart ^3.12.0
• Apple builds: Xcode and CocoaPods
• macOS: Homebrew dependencies from macos/Brewfile
• Windows: NuGet CLI on PATH; FFmpeg for release builds
• Linux: Flutter desktop toolchain, GTK development libraries, SQLite, and FFmpeg

Install and run

flutter pub get
dart run build_runner build
flutter run

Run code generation after changing Drift, Riverpod, Freezed, or JSON annotations, and commit generated outputs. Android uses store and direct distribution flavors; the direct flavor enables the sideload update path.

Verify

bash .github/scripts/validate_ci_gates.sh
bash .github/scripts/validate_ci_gates.sh --all

The first command checks formatting and generated-code drift. --all also runs analysis and tests. Equivalent individual checks are flutter analyze, flutter test, .github/scripts/check_dart_format.sh, and .github/scripts/check_codegen_drift.sh.

See AGENTS.md for platform rules and packaging.md for signing and release prerequisites.