Group expense splitting and settle-up app. Built with Flutter, Riverpod, GoRouter, and Supabase.

• Groups — Create groups (trips/events) with participants.
• Expenses — Log multi-currency expenses with payer and split type (Equal, Parts, Amounts).
• Balance — View who is owed / who owes; settle-up suggests minimal transfers.
• Record Settlement — Tap a settlement suggestion to record the payment and zero out the debt.
• Settings — Theme, language, and Local Only toggle.
• Offline-first — Works entirely offline via local SQLite. Syncs directly with Supabase when online.

When in Online mode and temporarily offline, you can still add expenses (queued for later sync). Other features like invites and member management require connectivity.

Details

Click to expand/hide

The app is deployed as a Progressive Web App (PWA). It works locally and offline.

• Install: Add to Home Screen via Chrome, Edge, or Safari.
• Offline: Works perfectly without an internet connection.

Option 1: Obtainium (Recommended) - Automatic Updates

• Manual Setup: Install Obtainium from F-Droid or GitHub Releases, then:
  • Open Obtainium and tap the "+" button
  • Select "GitHub Releases" as the source
  • Enter repository: Zyzto/Hisab
• Obtainium will automatically track new releases and notify you of updates

Option 2: Google Play Store WIP

• Available on Google Play Store (when published)
• Automatic updates through Play Store

Option 3: Direct Install (APK)

• Download the APK (e.g. app-release.apk) from GitHub Releases
• Enable "Install from unknown sources" in your Android settings
• Tap the downloaded APK file to install

• Flutter SDK ^3.10.0
• Dart ^3.10.0

flutter pub get
dart run build_runner build --delete-conflicting-outputs
flutter run

Without --dart-define parameters the app runs in local-only mode (no sign-in, no sync).

flutter run \
  --dart-define=SUPABASE_URL=https://xxxxx.supabase.co \
  --dart-define=SUPABASE_ANON_KEY=eyJhbGci...

For web: ensure web/sqlite3.wasm is present. Generate it with:

dart run powersync:setup_web

• State — Riverpod 3 with riverpod_annotation codegen.
• Navigation — GoRouter with ShellRoute and bottom nav.
• Data — Repository pattern: IGroupRepository, IParticipantRepository, IExpenseRepository.
  • Local SQLite (via PowerSync package) is the single local database engine.
  • When online, writes go to Supabase first, then update local cache.
  • Reads always come from local SQLite for speed and reactivity.
  • Complex operations (invite accept, ownership transfer, etc.) use Supabase RPC functions.
• Sync — DataSyncService handles: full fetch from Supabase, push pending offline writes, periodic refresh.
• Auth — Supabase Auth (email/password, magic link, Google OAuth, GitHub OAuth).
• Domain — lib/domain/: Group, Participant, Expense (amounts in cents), SplitType, SettlementTransaction.

For online mode, set up Supabase. See SUPABASE_SETUP.md for the full step-by-step guide covering:

• Creating the Supabase project and applying database migrations
• Configuring authentication providers (email, Google, GitHub)
• Deploying Edge Functions (invite-redirect, telemetry)
• Configuring --dart-define parameters

If no --dart-define values are provided, the app runs in local-only mode — all features work except sign-in and cross-device sync.

Full configuration reference: CONFIGURATION.md.

All secrets are provided at build time via --dart-define — nothing is committed to the repository. The only gitignored secrets file is lib/core/constants/app_secrets.dart which contains fallback placeholders.

The project includes a release workflow (.github/workflows/release.yml) that builds Android APK/AAB, deploys to Google Play, and deploys the web app to Firebase Hosting. It triggers on version tags (v*) or manual dispatch.

Go to repo Settings → Secrets and variables → Actions and add each secret.

Generate a keystore (one-time setup):

keytool -genkey -v \
  -keystore ~/hisab-release.jks \
  -keyalg RSA -keysize 2048 \
  -validity 10000 \
  -alias hisab

You will be prompted for a store password and a key password (press Enter at the key password prompt to reuse the store password).

Then base64-encode it:

base64 -w 0 ~/hisab-release.jks

Copy the keystore into the project for local signed builds (already gitignored):

cp ~/hisab-release.jks android/app/release-keystore.jks

Create android/key.properties (gitignored):

storeFile=/absolute/path/to/android/app/release-keystore.jks
storePassword=your_store_password
keyAlias=hisab
keyPassword=your_key_password

This project is licensed under Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0).

• You may share and adapt the material with attribution, for non-commercial use only, and you must share adaptations under the same license.
• Full legal text: LICENSE in this repo, or legalcode on the CC site.
• Human-readable summary: CC BY-NC-SA 4.0.