Chargeline docs
v1.0.0
Get help
● Start

Installation
app and server, step by step.

Commands below were taken from app/README.md and server/README.md and match the project files.

flutter pub getnpm ci

01Install and run the app

Windows users

Flutter runs natively on Windows: use PowerShell for the flutter commands and Android builds (iOS builds need a Mac). For the server, either install Node.js 22.12+ for Windows and use PowerShell (replace cp .env.example .env with Copy-Item .env.example .env; there is no openssl by default, so use WSL or any random 64-character hex string), or run the commands in WSL 2 (Ubuntu) or Docker. macOS and Linux users can ignore this note.

  1. Open a terminal in the app folder.
  2. Download packages:
    flutter pub get
  3. Run the tests (77 tests, they need no device):
    flutter test
  4. Run on a device:
    flutter run
    Pick the connected phone or simulator when asked.
  5. With your server: add the address at build time. Origin only, no trailing path.
    flutter run --dart-define=API_BASE_URL=https://chargeline.example.com
    Without it the app uses its built-in defaults and never contacts any server.
iOS first time

Run cd ios && pod install if Flutter asks for it, then open app/ios/Runner.xcworkspace in Xcode, select the Runner target, Signing & Capabilities, and choose your own team. The project ships with a team id that is not yours; replace it.

Simulator note

On the author's machine flutter build ios --simulator failed with a Flutter.framework architecture error under Xcode 27, so the app was not run in a simulator there; use a real iPhone or check your Xcode and Flutter versions. Shortcuts automations need a real iPhone anyway.

02Install and run the server

  1. Check Node: node -v must print 22.12 or newer.
  2. Create the settings file:
    cd server
    cp .env.example .env
  3. Make a secret key and paste it after ADMIN_SECRET_KEY= in .env:
    openssl rand -hex 32
    Keep a copy somewhere safe. It encrypts the store keys you save in the console.
  4. Install, build, start:
    npm ci
    npm run build
    npm start
    The server listens on port 8787. Test it: curl http://localhost:8787/healthz prints {"ok":true}.
  5. Open the console at http://localhost:8787/admin (next page: Console).

Development shortcut: npm run dev builds and starts. Full check (type check, lint, tests, build): npm run check.

03Do I need the server?

No. The app works fully offline. The server is for operators who want to change the paywall, feature switches, alert limits, announcements, force update and habit cards without shipping a build, to see opt-in install counts, and to confirm purchases with the stores.