Ocular

<br/>

<h3 align="center">
  <img src="https://github.com/simonwep/ocular/assets/30767528/2cbd76cd-adfb-4183-a69a-15784c4dccb6" alt="Logo" height="150">
</h3>


<h3 align="center">
  ✨ <a href="https://simonwep.github.io/ocular">Ocular</a> - Helps you see your budgets more clearly ✨
</h3>

<h6 align="center">
  <a href="https://simonwep.github.io/ocular/demo">Show me the demo</a> /
  <a href="https://simonwep.github.io/ocular/pages/quickstart">Getting started</a> /
  <a href="https://simonwep.github.io/ocular/pages/deploy">Deploy it!</a>
</h6>

<h6 align="center">
  <a href="https://www.pikapods.com/pods?run=ocular">
    <img alt="Run on PikaPods" src="https://www.pikapods.com/static/run-button.svg" height="150">
  </a>
  <a href="https://github.com/simonwep/ocular/pkgs/container/ocular">
    <img alt="Docker image pulls" src="https://raw.githubusercontent.com/simondump/static/refs/heads/master/apps/ghcr-pulls/dist/ocular.svg" height="150">
  </a>
</h6>


## Features

- ⭐ Handcrafted. No AI used during development, except for translations.
- 🏠 Self-hosted. [Deploy it](https://simonwep.github.io/ocular/pages/deploy.html) via docker in seconds.
- 🎨 Themed, light and dark mode.
- 🌍 Multi-language and support for all common currencies.
- 📱 Installable as a Progressive Web App and optimized for mobile devices.
- 🔁 Import your data from Google sheet's annual planner and export as JSON.
- 📊 Dashboard with extensive statistics and multiple charts including a Sankey diagram.
- ⌨️ Keyboard navigation for power users.
- 📈 All-time overview of your budgets including analytics.
- 🕶️ Privacy mode for when you're in a public place.
- 📅 Track budgets across multiple years.
- 👥 User management and authentication via app and cli.
- ⚙️ Customizable, financial year, start at any month.
- 🔄 Carry over budgets to the next year.
- 🧮 Inline expression evaluation.
- ...and much more!

## Links

- 📄 The documentation is hosted [here](https://simonwep.github.io/ocular/) including a [fully featured demo](https://simonwep.github.io/ocular/demo/dashboard#demo)
- ✨ Upcoming features for the next minor versions can be found under [milestones](https://github.com/simonwep/ocular/milestones)
- 🚀 The latest release including feature list can be found under [releases](https://github.com/simonwep/ocular/releases)
- 📦 Ocular is deployed as a single container, the images are uploaded under [packages](https://github.com/simonwep/ocular/pkgs/container/ocular)

## Screenshots

<img width="1660" height="1070" alt="Dashboard" src="https://github.com/user-attachments/assets/3391dcaa-da27-4b72-ba7d-42a50b1c1023" /> <br/>
<img width="1660" height="1070" alt="Dashboard Yearly Overview" src="https://github.com/user-attachments/assets/2b423d9a-b800-4977-bb6e-5431a3644498" /> <br/>
<img width="1660" height="1070" alt="All-time Overview" src="https://github.com/user-attachments/assets/09bf8cf4-acf0-479c-bc28-e5f40a238279" /> <br/>
<img width="1660" height="1070" alt="Demo expenses" src="https://github.com/user-attachments/assets/ed687574-6ae6-4af4-8ab4-f09e0907f4bf" />

<p align="center"><i>...the rest is up to you to <a href="https://simonwep.github.io/ocular/demo">discover</a> ✨</i></p>