Install & run

From the ZIP to a running app.

Budgelyx is an Expo project. You build it with your own Xcode and Android tooling; nothing has to be hosted. These are the commands the release was verified with.

Requirements

Node.js22.13+ (tested 24.21)

Expo SDK57

React Native0.86.3

iOSXcode 26+ (tested 27.0)

AndroidSDK 36 · JDK 17

Paid servicesnone to run

In the ZIP

mobile/ — the Expo app with its own package-lock.json
docs/ — source map, customization, native builds & signing, data model, testing, troubleshooting
START-HERE.md, buyer scope, asset credits and the Webloomery Template License

1 · Install and test

cd mobile
npm ci
npm test            # 45 domain, persistence and backup tests
npm run typecheck
npm run lint

2 · Run on a simulator or emulator

# iOS Simulator (macOS + Xcode)
npx expo run:ios

# Android emulator (Android Studio, SDK 36, JDK 17)
npx expo run:android

On first launch choose a currency, then Start with an empty budget or Explore with demo data.

3 · Release builds

npx expo run:ios --configuration Release
npx expo run:android --variant release

Store builds need your own identifiers (src/config/brand.ts), your Apple Developer team for iOS signing and your own upload key for Google Play. docs/NATIVE-BUILD.md walks through both, plus optional EAS Build with your own account.

4 · Make it yours

Change	File
Name, bundle ids, URL scheme, database name	`mobile/src/config/brand.ts`
Colours, fonts, spacing	`mobile/src/config/theme.ts`
App icon, Android adaptive icon, splash	`mobile/assets/brand/`
All wording (localization-ready)	`mobile/src/content/strings.ts`
Demo household and starter envelopes	`mobile/src/data/`
Currencies and decimal places	`mobile/src/config/currency.ts`

What you will not need

No server, database host, API key or subscription is required to run Budgelyx. Data lives in SQLite on the device.

What costs money, if you publish

Apple Developer Program for TestFlight/App Store and a Google Play developer account are yours to set up. Optional services you add later (sync, bank import, analytics) bring their own costs.