Quickstart

NOTE

This documentation is brand new ✨ If you have any questions or something's missing, feel free to open an issue 💖

Summary

Ocular is a small budgeting app, initially implemented 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).

If you are not sure if it's something for you, check out the demo.

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.

What's next?

• 🤖 If you want to install it, head over to deployment.
• 🤨 If you have any questions, check out the FAQs.
• 🐞 Having troubles setting it up? Please open an issue at github/ocular-docker.
• 💡 Missing a feature or found a bug? Please open an issue at github/ocular.
• 🧑‍💻 Want to contribute? Head over to our contributing guidelines.

Feature list

Notable features of Ocular:

• Self-hosted. Deploy it via docker-compose in seconds, your data stays on your server.
• Themed, light and dark mode.
• Multi-language and currency support.
• Installable as a Progressive Web App and optimized for mobile devices as well.
• Import your data from Google sheet's annual planner or export as json.
• Dashboard with extensive statistics and a detailed view with sankey diagram.
• 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.
• Customizable, financial year, start at any month.
• Carry over budgets to the next year.
• ...and much more!

Repositories

There are three repositories involved with this project:

• ocular - The main repo with the source of this documentation, the frontend and all you need to work on the app.
• ocular-docker - The docker-compose setup for the app. This is the one you want to use if you want to deploy it.
• genesis - A generic backend powering the app. Usually no change is needed here as it's kept unrelated to the app itself (but initially made for it).