Skip to content

sokratis1988/ocular

 
 

Repository files navigation


Logo

Ocular - Helps you see your budget more clearly.


CI Status

Features

  • 🔐 Simple login via google drive.
  • 🌚 Dark / light theme.
  • 💻 Installable (PWA).
  • ⬆️ Import your data from Google sheet's annual planner.
  • ⬇️ Export your data as a single .json-file.
  • 🕰 Add a budget for up to a year ahead.
  • ...full mobile support (#4).

Check out the demo!

Summary

A small budgeting app as an alternative to Google sheet's annual budget planner. The goal of the app 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 without any backend and all your data is stored in your google-drive account as an app (no worry - you can always export your data in the app). This app does not have access to anything else except its own files. The (latest) version I use is automatically deployed to ocular.reinisch.io - but feel free to set it up yourself!

Attention: It's currently not possibly to sync the app with your personal gmail account due to the google-cloud app not being verified yet. You can still use it and download / upload your data or deploy it yourself (which is even cooler!).

Thanks, @nateseymour for coming up with a good name for this!

State of this project

I consider the current state of it as the MVP for my personal use. But I'm planning on adding more features - I'm not planning of making it any more in-depth as it already is, planned features may only include adding a way to define goals or general improvements for mobile usage. As I already said, if you're looking for an in-depth tool to manage your finances check out firefly!

Contributing

If you want to work on this, make sure to out the contributing guidelines :) Furthermore this project does not have releases. Because of its simplicity the master branch is considered stable and any new feature will directly be merged into it.

Development

This app requires NodeJS LTS and uses vite as builder. You can build and preview the app using the following commands:

npm run build npm run preview

To work on it simply run npm run dev.

Production

To run this app in production and to add cloud connectivity, you'll need a Google Cloud App with the drive.appdata scope.

After you've set up your app fill copy the .env.example to .env and fill in your credentials.

About

💰 Simplistic and straight-forward budgeting app to track your budget across a year. Installable. Easy to use.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Vue 59.7%
  • TypeScript 30.8%
  • SCSS 8.0%
  • HTML 1.1%
  • Other 0.4%