Personal Finance Tracker

A dashboard to add and view your expenses and how much you have spent in each category. Also allows users to add investments which who's value is updated in real-time utilizing a 3rd party stock market API and renders a piechart to showcase the portfolio diversity of the user.

View Production Site ·

Table of Contents

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

About The Project

A dashboard to view your expenses, the value of your investments and the diversity of your portfolio.

(back to top)

Built With

• React.js
• TypeScript
• Mantine
• Supabase

(back to top)

Getting Started

Ensure you have the latest version of NodeJS and npm installed. This project uses Vite so some of the commands you may be used to would be different.

Installation

1. Get a free API Key at Supabase
2. Clone the repo

   git clone https://github.com/aghilann/Finance-Tracker.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Roadmap

• Navigation Bar
  • Implented Auth via Supabase Auth
  • Added Light and Dark Mode functionality using Mantine
  • Select a global color scheme
• Expenses
  • Viewing Total's for Expense Categories
  • Created a rendering of the Expense Table
  • Added ability for user's to add Expenses
• Investments
  • Added the ability for User to add stock investments and their number of holdings
  • Implemented Autocomplete Functionality for stocks
  • Used React Query to fetch latest stock prices from Yahoo Finance API
  • Created Grid of Cards displaying the latest value of each Stock
  • Visualized Portfolio Diversity using a Piechart from ReCharts
• Finance News
  • Used React Query to receive data from Microsft Azure News API display the headlines with the author, thumbnail and preview.

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

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Aghilan Nathan - [email protected]

(back to top)