Skip to content

dreamxist/balance

Repository files navigation

Balance

Opinionated personal finance, built around one promise: every peso is located and explained.

Balance is a personal-finance app for developers who want full control over their money model. It is built on top of Supabase, ships a TypeScript CLI, and uses the Balance Assertion with Reconciliation pattern at its core: your real positions (cash in accounts, cards, investments, debts) must always equal the sum of your registered transactions. Delta = 0 or you find out fast.

This is not a YNAB or Mint replacement. It is a self-hosted, code-first alternative for people who like spreadsheets, the command line, and the idea that their financial system should be auditable end to end.

Status: Beta — building in public. Used daily by the author to migrate 9 years of Excel history. Schema is stable; UI iterating.


Demo

Balance demo

Replace docs/assets/demo.gif with a real recording. A 20-second loop showing bal balance + the dashboard works well.


Features

  • Balance assertion engine. Position vs. accumulated, delta = 0, or you debug it.
  • First-class CLI. Add expenses, income, transfers, and debt payments without touching the browser.
  • Web dashboard. React + Vite SPA: net worth, cash flow, debts, recurring charges, snapshots.
  • Multiple account types. Cash, debit, credit cards, investments (Fintual integration), debts, receivables, properties.
  • Installment-aware debts. Buy now, register later: full expense at purchase, monthly debt payments tracked separately.
  • Recurring charges. Edge function cron auto-registers monthly subscriptions and debt installments.
  • Snapshots & immutable history. Transactions are never edited or deleted — corrections happen via undo / refund / adjustment.
  • Strict isolation. Postgres RLS on every table. CLI uses short-lived JWTs minted from API keys, never service_role.
  • Fully self-hostable. Supabase free tier is enough for personal use.

Stack

Supabase Postgres TypeScript React Vite License: MIT

Layer Tech
Database Supabase Postgres + RLS + PL/pgSQL functions
Edge runtime Supabase Edge Functions (Deno)
Web React 19, Vite 8, TanStack Router/Query, Tailwind v4
CLI Node 22+, TypeScript, commander
Monorepo npm workspaces + Turborepo
Deploy Vercel (web) + Supabase (db/functions)

Quick start (CLI)

The published CLI is @dreamxist/bal-cli. You still need a Supabase backend with the Balance schema deployed — see SETUP.md.

# 1. Install
npm install -g @dreamxist/bal-cli

# 2. Point at your backend + log in with an API key
export SUPABASE_URL="https://<project-ref>.supabase.co"
export SUPABASE_ANON_KEY="<anon-key>"
bal login --api-key bal_...

# 3. Check your books
bal balance

More commands:

bal add 12000 supermercado --account "Checking"
bal add 1500000 sueldo --type income --account "Checking"
bal list --period month --type expense
bal key list

Full reference: apps/cli/README.md.


Self-host

Balance is designed to run on your own Supabase project. Step-by-step instructions, including migrations, edge functions, secrets, and cron setup, live in SETUP.md.

Costs: a personal-scale install fits comfortably in the Supabase free tier (one project, < 500 MB DB, daily edge-function cron). Web hosting is also free on Vercel.


Project layout

balance/
├── apps/
│   ├── cli/        # bal CLI (published as @dreamxist/bal-cli)
│   └── web/        # React + Vite SPA
├── packages/
│   └── core/       # Shared TypeScript business logic
├── supabase/
│   ├── migrations/ # SQL migrations (run via `supabase db push`)
│   ├── functions/  # Edge Functions (auth-apikey, daily-charges, ...)
│   └── tests/      # pgTAP tests
├── docs/           # Architecture, workflows, design notes
└── tests/          # Engine + edge-function integration tests

Documentation

License

MIT © 2026 Francisco Zúñiga Palma.

Author

Built by Pancho Zúñiga — fullstack developer, building in public at github.com/dreamxist.

If Balance is useful to you, a star on GitHub or a note about your setup helps a lot. Issues and PRs welcome.

About

Personal finance app with Balance Assertion + Reconciliation (delta = 0). Self-hosted Supabase backend + TypeScript CLI + React dashboard. @dreamxist/bal-cli on npm.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors