https://github.com/simonwep/ocular

💰 Simplistic, beautiful and straight-forward budgeting app to track your budget across the years. Easy to use, to get started and to set up.
https://github.com/simonwep/ocular

budget-app budgeting budgets cash-flow expenses finance finance-management financial personal-finance self-hosted vue3

Last synced: about 1 month ago
JSON representation

💰 Simplistic, beautiful and straight-forward budgeting app to track your budget across the years. Easy to use, to get started and to set up.

• Host: GitHub
• URL: https://github.com/simonwep/ocular
• Owner: simonwep
• License: mit
• Created: 2022-03-24T17:36:17.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-01T13:11:57.000Z (about 2 months ago)
• Last Synced: 2024-05-02T05:00:25.523Z (about 2 months ago)
• Topics: budget-app, budgeting, budgets, cash-flow, expenses, finance, finance-management, financial, personal-finance, self-hosted, vue3
• Language: Vue
• Homepage: https://ocular.reinisch.io
• Size: 4.84 MB
• Stars: 13
• Watchers: 2
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Lists

• fucking-awesome-selfhosted - Ocular - Simplistic and straightforward budgeting app to track your budget across months and years. 🌎 [Demo](ocular.reinisch.io/#demo)) `MIT` `Docker` (Software / Money, Budgeting & Management)
• awesome-selfhosted - Ocular - Simplistic and straightforward budgeting app to track your budget across months and years. ([Demo](https://ocular.reinisch.io/#demo)) `MIT` `Docker` (Software / Money, Budgeting & Management)
• awesome-selfhosted - Ocular - Simplistic and straightforward budgeting app to track your budget across months and years. ([Demo](https://ocular.reinisch.io/#demo)) `MIT` `Docker` (Software / Money, Budgeting & Management)

README

        





  








  ✨ Ocular - Helps you see your budgets more clearly ✨





  



> [!TIP]

> Check out the [demo](https://ocular.reinisch.io#demo) to get a live preview with demo data!

## Features

- 🦾 Self-hosted. [Deploy](https://github.com/simonwep/ocular-docker) 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!

## Summary

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](https://www.firefly-iii.org/)).

This app comes with its own backend (by using [genesis](https://github.com/simonwep/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.

## Setup

### Development

1. Make sure you have the latest [node LTS](https://nodejs.org/en/) installed.

2. Install [pnpm](https://pnpm.io/) via `npm i -g pnpm`.

3. Clone this repository.

4. Run `pnpm install` in the root directory.

5. Copy the `.env.example` to `.env`, you can leave the default values.

6. Start the backend with `pnpm run genesis`.

7. Start the frontend with `pnpm run dev`.

8. Open `http://localhost:3000` in your browser.

> [!NOTE]  

> To modify the backend, head over to [genesis](https://github.com/simonwep/genesis).

### Production

This app is deployed using [docker-compose](https://docs.docker.com/compose/).

See [ocular-docker](https://github.com/simonwep/ocular-docker) for deployment.

### Contributing

If you want to work on this, make sure to out the [contributing guidelines](CONTRIBUTING.md) :)

Other than that, follow the steps under [development](#development) to get started.