Need For Spend

Table of Contents

1. FAQ
2. About The Project
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Roadmap
6. Contributing
7. License
8. Contact
9. Acknowledgments

About The Project

What is Need For Spend

The Safe and Secure Way to Track Your Spending with Plaid Need For Spend is an app that allows you to easily connect your bank accounts and track your spending all in one place. By integrating withPlaid, a trusted third-party API, Need For Spend is able to provide you with an accurate and up-to-date view of your finances.

What is Plaid

One of the main benefits of using Need For Spend is the security and safety that comes with using Plaid. Plaid is a leading financial technology company that is trusted by millions of people and institutions around the world. By using Plaid, Need For Spend is able to securely access your financial data without storing your login credentials or sensitive information. This means that you can rest assured that your personal and financial data is protected at all times.

Is Need For Spend and Plaid safe to use

Need For Spend takes security very seriously and has implemented the highest industry standards to ensure the safety of your information. With Need For Spend, you can easily track your spending across all of your accounts and get insights into your financial habits. By understanding your spending patterns, you can make better financial decisions and achieve your financial goals. Get started with Need For Spend today and take control of your finances with confidence and security.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Get your Plaid API keys from the dashboard: https://dashboard.plaid.com/team/keys
2. Clone the repo

   git clone https://github.com/jaycchiu524/need-for-spend.git

3. Install dependencies

   yarn

4. Add a new .env file

   # Add new .env at root
   cp .env.example .env

   Fill the environment variable from Plaid .env

    PLAID_CLIENT_ID=
    PLAID_SECRET=
    ...
   

Usage

• Development

    # root dir
    make debug
  
    # Web client running at localhost:3000
    # Server running at localhost:8080

(back to top)

Roadmap

• Database schema
• Connect Plaid API with database
• Add Basic UI with MUI
• Add charts with D3.js
• Containerization with Docker
• Add WebSocket & Webhook for updating data at real time
• Optimisation of UI and data fetching

(back to top)