Expenses-Analyzer

A React based app, that allows to safely analyze bank account logs stored in .csv files
Explore the docs »

View Demo · Expenses-analyzer Bug · Request Feature

Table of Contents

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

About The Project

Expenses analyzer is a React-based app, that allows the user to analyze bank statements from (at the moment) polish Mbank bank accounts.

Built With

• React

Getting Started

To get a local copy up and running follow these simple 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

1. Clone the expenses-analyzer

   git clone https://github.com/Kielx/expenses-analyzer.git

2. Install NPM packages

   npm install

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

Current state of app:

In current state Expenses-Analyzer allows users to do basic analysis of Polish MBank account data extracted from bank. I provided the app with 'load default data' button, that presents some data to show how app works.

Features planned/TODO:

• Graph displaying over time incomes/expenses analysis
• Insights about particular expenses
• Amounts spent on particular type of activity (eg. food, electronics, leisure)
• Routes
• Polish translation (since it supports only polish MBank account data for now)

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

Contributing

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

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

License

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

Contact

Kielx.dev@gmail.com

Project Link: https://github.com/Kielx/expenses-analyzer