A 3-tier web application for monitor financial status and monthly spending.
📊 Project Storyboard: Biller
- 🙍🏻♀️ Signup/Login with Biller
- 🔏 Protect your data with JWT authentication
- 🏦 Connect to your Bank online account (Chase, Wells Fargo, etc.)
- 📑 Connect to utilities account (PG&E, comcast, etc.)
- 💳 Manage your credit card usage
- 💵 Monitor your income and expenses' transactions
- 📈 Visualize your income and spending in a graph
- ⏰ Alert incoming bills
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
What things you need to install the software and how to install them
- Install Node.js/npm
- Install python3/pip3 (Version >= 3.6)
- Install MySQL
# Clone this repository
git clone https://github.com/trinityng/biller
# Go into the repository
cd Biller
# Go into client folder
cd client
# Install client dependencies
npm install
# Start client on localhost:3000
npm start
# Create virtual environment (recommend) using conda/virtualenv
conda create --name your_env_name
# Start virtual env
source activate your_env_name
# Setup Plaid API Keys
# Go into server folder
cd server
# Create a file in a root server folder called "Plaid_API_Keys"
# Place your PLAID_CLIENT_ID, PLAID_SECRET, and PLAID_PUBLIC_KEY in the file
# Install server packages from requirements.txt
pip3 install -r requirements.txt or python -m pip3 install -r requirements.txt
# Create new migrations
python3 manage.py makemigrations
# Apply new migrations
python3 manage.py migrate
# Start server on localhost:8000
python3 manage.py runserver
# Test server using Django unittest
cd server
python3 manage.py test
# Test client using Jest and Enzyme
cd client
npm test
👩🏻💻 Trinity Nguyen - trinwin (Project Lead + Frontend Lead)
👨🏻💻 Au Tran - au-tran (Backend Lead)
👨🏻💻 Matthew Vu - Redjay17 (Frontend Developer)
See also the list of contributors who participated in this project.