โจ Ocular - Helps you see your budgets more clearly โจ
Tip
Check out the demo to get a live preview with demo data!
- ๐ฆพ Self-hosted. Deploy it via docker-compose in seconds.
- ๐ถ๏ธ Beautiful light and dark theme.
- ๐ป Installable as a PWA.
- ๐ผ Import your data from Google sheet's annual planner.
- ๐ ๏ธ Export your data as a single
.json
-file. - โจ Dashboard with sankey diagram and a detailed view.
- ๐ Track budgets across multiple years.
- ๐ Privacy mode for when you're in a public place.
- โก๏ธ Simple, fast and straight-forward UI.
- ๐ซ User management and authentication.
- ...and more to come!
Ocular is a small budgeting app as an alternative to Google sheet's annual budget planner. Its goal is not to track individual expenses, work with multiple currencies at a time or anything related (if you're looking for something like this, check out firefly-iii).
This app comes with its own backend (by using genesis), so the only thing you need to do is to host it somewhere. Your data stays on your server and is not shared with anyone else.
- Make sure you have the latest node LTS installed.
- Install pnpm via
npm i -g pnpm
. - Clone this repository.
- Run
pnpm install
in the root directory. - Copy the
.env.example
to.env
, you can leave the default values. - Start the backend with
pnpm run genesis
. - Start the frontend with
pnpm run dev
. - Open
http://localhost:3000
in your browser.
Note
To modify the backend, head over to genesis.
This app can be deployed using docker-compose. See ocular-docker for deployment.
If you want to work on this, make sure to out the contributing guidelines :) Other than that, follow the steps under development to get started.