https://github.com/cwdalziel/bitcamp-2024

Budget Hero: A gamified finance tracking website
https://github.com/cwdalziel/bitcamp-2024

Last synced: about 1 month ago
JSON representation

Budget Hero: A gamified finance tracking website

• Host: GitHub
• URL: https://github.com/cwdalziel/bitcamp-2024
• Owner: cwdalziel
• Created: 2024-04-20T17:43:03.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-04-21T07:37:45.000Z (8 months ago)
• Last Synced: 2024-04-22T08:51:51.154Z (8 months ago)
• Language: Python
• Homepage:
• Size: 703 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![logo](icon.png)

## Budget Hero is a finance-tracking website

We built Budget Hero to gamify the experience of saving money. In this project, you'll defeat bad credit, overcome gambling addiction, and play the stock market safe—literally. Your character, Mr. Coin, will fight against these forces on your behalf.

## How it works

Budget Hero has its own backend, which calls the `nessieisreal` CapitalOne API and allows you to track your finances. Whenever you add a positive transaction, whether that be a check, money transfer, or sale, Mr. Coin will attack the enemies on your behalf. On the other hand, if you lose money due to debt, purchases, or any other reason, Mr. Coin will lose his health. Try to defeat the largest number of enemies before losing all of your HP! 

## Developers:

* [cwdalziel](https://github.com/cwdalziel) - Frontend / React App

* [nkasica](https://github.com/nkasica) - Backend / Artwork

* [yuwex](https://github.com/yuwex) - Backend / Database

## Running the Project

### Frontend

This projet's frontend was created with [Create React App](https://github.com/facebook/create-react-app). 

After installing `npm` on your device, use the following command to build this project.

### `npm run build`

Then, start this project with the following command.

### `npm start`

### Backend

This project's backend was created with [FastAPI](https://fastapi.tiangolo.com/).

To set up the backend, follow these steps:

1) Create a virtual environment for python with `python3.10 -m venv .venv`

2) Switch to that environment with `source .venv/bin/activate`

3) Install required dependencies with `pip install -r backend/requirements.txt`

To run the backend, do the following:

1) Ensure you are using the virtual environment. If not, repeat step 2.

2) Run `python backend/main.py`