Skip to content

Quick Start

First launch

  1. Download and install from the releases page (see Installation for platform-specific instructions).
  2. The app opens with a splash screen, then loads the main dashboard.
  3. Without Akahu tokens configured, panels will be empty. Head to Settings > Connections to connect your bank accounts.

Dev mode (browser)

You can run the full UI in a browser without Electron or bank credentials:

bash
npm run dev

This starts the development server at http://localhost:5173 with mock data — a Wellington household with realistic transactions, accounts, and budgets.

This is useful for:

  • UI development without an Electron rebuild cycle
  • Testing themes, layouts, and chart rendering
  • Working without bank credentials

Dashboard overview

The dashboard contains 19 draggable, resizable panels:

  • Drag panels via the header bar
  • Resize from edges and corners
  • Collapse/expand with the header toggle button
  • Pin a panel to prevent accidental moves

Open Settings > Layout to save and load panel arrangements.

Connecting your bank

  1. Open Settings > Connections tab
  2. Paste your Akahu App Token and User Token
  3. Click Sync
  4. Transactions and account balances populate automatically

See Akahu Setup for a detailed walkthrough on obtaining tokens.

Next steps

  • Akahu Setup -- detailed guide to connecting NZ bank accounts
  • Themes -- customize the look with 20+ built-in themes and 7 fonts