https://github.com/arsamsarabi/money-diary

Full stack expense tracking and budgeting application
https://github.com/arsamsarabi/money-diary

apollo-server-express expressjs graphql mongodb mongoose nodejs scss tyescript vue vue-router vuejs vuex

Last synced: 3 days ago
JSON representation

Full stack expense tracking and budgeting application

• Host: GitHub
• URL: https://github.com/arsamsarabi/money-diary
• Owner: arsamsarabi
• License: mit
• Created: 2020-04-23T15:50:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T13:53:28.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T15:46:27.486Z (over 1 year ago)
• Topics: apollo-server-express, expressjs, graphql, mongodb, mongoose, nodejs, scss, tyescript, vue, vue-router, vuejs, vuex
• Language: Vue
• Homepage:
• Size: 2.25 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 31
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# 💵💵💵 Money Diary 💵💵💵

> Open Source expense tracking and budgeting application

🚧⛔️🚧 Under Construction! 🚧⛔️🚧

👨🏻‍💻 Author: [Arsam Sarabi](http://arsam.io)

- 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](https://www.docker.com/get-started) to manage this task. See [this web page](https://cloudnweb.dev/2019/11/how-to-run-mongodb-as-a-docker-container-in-development/) for how-to(s) on running local [MongoDB in Docker](https://hub.docker.com/_/mongo).

> There is also a short version of it [here](https://github.com/arsamsarabi/money-diary/blob/master/back/README.md)

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](https://auth0.com/) 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](./CONTRIBUTING.md) and get involved!