Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 2.7 KB

README.md

File metadata and controls

67 lines (43 loc) · 2.7 KB

🌟 Community-Powered Repository 🌟

This repository is crafted with ❤️ by our talented community members. It's a space for everyone to use, contribute to, and share. While it aligns with the spirit of our community, please note that this repo is not directly endorsed or supported by Investec. Always exercise caution and discretion when using or contributing to community-driven projects.

📊 Budgify

A web app that helps you budget and gain insight into your spending habits with Programmable Banking.

  • Budgify provides a dashboard view of your current account balance, total income and total expenses as well as automated categorisation of your transactions.
  • It also provides you with a weekly breakdown of your income and expenses.
  • Budgify uses the Investec Transaction History API

Dashboard

☑️ Requirements

🔑 Preparations

You will need to have your Investec API keys at hand. Specifically, your client ID, client secret and API key. You can learn more about getting your Investec API keys in the Quick Start Quide.

🚀 Getting Started

We encourage you to fork this repository to your GitHub account. This allows you to easily stay up to date with new changes to the app without losing any local customizations you may make to it. To fork this app, please see the following guide

Once you have forked the repo, please clone it.

Open your terminal and run the following:

git clone https://github.com/programmable-banking-community/budgify
Rename the `.env.local.example` to `.env.local`

Then run the following:

cd budgify
npm install
npm run dev

Open http://localhost:3000 with your browser to see the result.

🧑‍💻 Contributions

Possible additions:

- The ability to select a specific date to filter transactions
- Select a different accounts and see the transactions per account
- A graph which displays the spend for each category
- Allow a user to edit/create/select categories

Pull requests and changes are welcome.

📄 License

This project is MIT licensed.