💵💵💵 Money Diary 💵💵💵

Open Source expense tracking and budgeting application

🚧⛔️🚧 Under Construction! 🚧⛔️🚧

👨🏻‍💻 Author: Arsam Sarabi

• Track your Expenses
• Review your Accounts
• Set Budgets
• Plan your Savings

Build using:

Backend

• TypeScript
• Nodejs/ Expressjs
• apollo-server-express
• MongoDB/ Mongoose

Frontend

• Vue js
• VueX
• Vue Router
• SCSS

How to run the app locally

Firstly, You need to have an instance of MongoDB running. I recommend using Docker to manage this task. See this web page for how-to(s) on running local MongoDB in Docker.

There is also a short version of it here

Once you have a DB running, look into the front and back folders. Copy & paste .env.example files and rename them to .env. In the backend the DB_URL could be something like mongodb://localhost:27017/money-diary

For the frontend, You need to have an Auth0 application registered; Grab the application's Domain and Client ID from your Auth0 account and populate the relevant environment variables on the frontend .env file.

With any luck, you should now be able to run yarn install && yarn dev in the back and yarn install && yarn serve in the front

Janitor

Populates the database with generic categories and test data.

Get involved?

I welcome anyone who is interested in contributing to this project. From feature requests and ideation to bug reporting and submitting PRs. Please read the CONTRIBUTING.md and get involved!