Reading the repo
Opening the box…
Reading the repo
Opening the box…
Assembly instructions
Privacy-first Android personal finance, expense tracker and money manager built with Kotlin & Jetpack Compose. Track budgets, mobile money, wallets, bills and multi-currency finances offline.
Saved setup from 1 h ago
Will it work on macOS?
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: xcode-select --install
git clone https://github.com/NyotaFoundry/Mizani.git cd Mizani
JDK, adb (Android platform-tools)
brew install openjdk@21 brew install --cask android-platform-tools
./gradlew build -x test
./gradlew run
The checked-in Gradle daemon criteria select JetBrains Runtime 25 and provide download URLs for supported platforms. The Xcode build phase needs a local JDK 17 or newer to start Gradle; it checks <code>JAVA_HOME</code>, <code>ANDROID_STUDIO_JDK</code>, Android Studio's standard macOS JBR location, then the system JDK registry. Android Studio can create <code>local.properties</code> for the Android SDK location; that file is intentionally ignored by Git.
Clone the repository and build with the Gradle wrapper:
git clone https://github.com/NyotaFoundry/Mizani.git
cd Mizani
.\gradlew.bat :app:assembleDebug
On macOS or Linux, use <code>bash ./gradlew</code> in place of <code>.\gradlew.bat</code>.
The APK is written to <code>app/build/outputs/apk/debug/app-debug.apk</code>. Install it on a connected device or emulator with:
adb install -r app/build/outputs/apk/debug/app-debug.apk
The Android CI workflow runs on pull requests and pushes to <code>main</code>: it tests shared
rules on the host, runs Android unit tests and builds the debug APK. The separate iOS CI workflow
runs on macOS and builds the SwiftUI preview against the KMP framework, so a broken Apple build is
caught before release. Its MizaniCore package test suite still has a known backlog and is tracked
separately instead of failing every run. Android instrumentation tests remain a local check because
they need a disposable emulator and clear its app data. The iOS job verifies compilation and shared
rules only; the iOS client remains a preview, not a financial app ready for distribution.
.\gradlew.bat :app:testDebugUnitTest
.\gradlew.bat :shared:testAndroidHostTest
.\gradlew.bat :app:assembleDebugAndroidTest
On the supported Mac toolchain, the iOS encrypted-storage package tests run with:
swift test --package-path iosApp/MizaniCore
To run the Android instrumentation suite, connect a disposable emulator and use:
.\gradlew.bat :app:connectedDebugAndroidTest
Test data warning: Instrumentation tests clear the app’s local database and settings. Run them only on a disposable emulator or test profile, never on a device containing a ledger you need to keep.
The repository includes an early native SwiftUI client backed by the KMP :shared framework and
the MizaniCore SQLCipher package. It supports local workspace and wallet setup, categorized
ledger entry, transfers, refunds, adjustments, Activity search, category and income-source
management, savings goals, and manual investment snapshots, plus a current-month cash-flow and
spending-by-category summary calculated by shared KMP rules. Full Android Insights parity is not implemented. It remains incomplete
and must use test data until Apple-platform builds and security checks pass. On a Mac with the
required toolchain, compile it for the simulator with:
xcodebuild -project iosApp/Mizani.xcodeproj -scheme Mizani \
-destination 'generic/platform=iOS Simulator' CODE_SIGNING_ALLOWED=NO build
The Xcode build phase finds a JDK and invokes Gradle through
<code>scripts/ios/build-shared-framework.sh</code>. This command is a compile check only; open
<code>iosApp/Mizani.xcodeproj</code>, select an installed simulator and run the app separately to
exercise its flows. Run swift test --package-path iosApp/MizaniCore for the encrypted storage and
repository package tests. The target is not ready for financial use or App Store submission; see the
iOS readiness checklist for required implementation and review
work. iOS build and simulator checks require macOS and Xcode.
To measure the distribution build instead of the larger development APK, run:
.\gradlew.bat :app:assembleRelease
The output is <code>app/build/outputs/apk/release/app-release-unsigned.apk</code>. Release builds shrink code and resources and package only ARM native libraries; debug builds also include emulator ABIs and development code. The release APK must be signed before Android can install or distribute it. For this repository, release signing is configured with the four <code>MIZANI_RELEASE_*</code> Gradle properties.
Set <code>mizaniVersionName</code> in <code>gradle.properties</code> using <code>MAJOR.MINOR.PATCH</code>; Gradle derives Android’s <code>versionCode</code> from it. A release build is unsigned unless all four <code>MIZANIRELEASE*</code> signing properties are configured. Keep signi
…
No reports for macOS yet.
GitManual AI Agent reads the 4 key files and writes a step-by-step guide for macOS. Once written, it's saved for everyone.