Personal Finance App

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. License
5. Contact
6. Acknowledgments

About The Project

The Personal Finance Application allows users to view and monitor transactions associated with their accounts.

The main features provided are:

• A dashboard that displays all connected accounts and their current balance.
• Users can view their transactions and it's categorization.
• Secure connection to user's bank account using the Plaid Link API.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

This project uses npm

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/sdolmo/personal-finance-app-web-js.git

2. Install NPM packages

   npm install

3. In the project directory, you can run:

  npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in your browser.

(back to top)

Usage

For Developers

To use the application, you must have a Plaid account. You can create one here.

Once you have an account, you can connect your PLAID_CLIENT_ID and PLAID_SECRENT in the .env file.

Use the following credentials to connect to the sandbox environment:

• Username: user_good
• Password: pass_good
• Code: credential_good

Use Live Demo

To just use the live demo, you can use the following credentials:

1. Login using a name and email address
2. Use the following credentials to connect to the sandbox environment:

• Username: user_good
• Password: pass_good
• Code: credential_good

3. View your transactions

(back to top)

Roadmap

• Add README
• Implement React Router
• Add pages
  • Home
  • Login
  • Accounts
  • Balances
  • Transactions
• Update Google Charts with mock data --> Used AG Grid Instead
• Update Year/Month selector widget --> Used AG Grid instead
• Get Transactions from Plaid API to display on the Transactions page
• Update Styling
• Code clean up
  • Spending Component
  • Remove Balances Page
• Host on Netlify 🎉

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, you can open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Sylvia Dolmo - @SylviaDolmo - sylviadolmo@gmail.com

Project Link: https://github.com/sdolmo/personal-finance-app-web-js

(back to top)

Acknowledgments

• Best-README-Template
• PIRATE KING

(back to top)