mirror of
https://github.com/jcreek/bank-statement-analyser.git
synced 2026-07-12 18:33:46 +00:00
Josh Creek
67 lines
2.9 KiB
Markdown
67 lines
2.9 KiB
Markdown
# bank-statement-analyser
|
|
|
|
## Introduction
|
|
|
|
This project is designed to:
|
|
|
|
- Import a csv file (bank statement), ignoring any entries that already exist upon import
|
|
- Apply tags/categories to each transaction
|
|
- Be able to set rules to auto apply these, or manually set them for each item on a statement when adding it in
|
|
- Have separate categories for savings and expenditure
|
|
- Be able to summarise (with graphs) expenditure and savings for any selected time period
|
|
- Be able to expand the above summaries for more detailed information
|
|
- Be able to calculate your current FIRE status (i.e. how much you save in a year, and, assuming a return of x%, how much your yearly income from investing your savings would be, compounding to calculate how long until you hit a minimum retirement goal - vaguely similar to https://app.fin-dee.com/)
|
|
- Be able to analyse and capture trends in expenditure and saving across months/years
|
|
|
|
All data is stored in localstorage on the user's device, exportable as json for backup and re-import purposes. This enables greater security and confidence (other than being able to go through the source code with a fine toothed comb).
|
|
|
|
If you wish to contribute other bank statement csv formats or features then please do!
|
|
|
|
## Project to do list
|
|
|
|
### Things for version 1.0
|
|
|
|
1. ~~Set up adding statement lines and displaying them~~
|
|
2. ~~Set up adding and saving statement lines with localstorage, and reloading from localstorage~~
|
|
3. ~~Set up importing a csv file (bank statement) to the data structure, adding each line ignoring different accounts~~
|
|
4. ~~Modify that to ignore any entries that already exist upon import~~
|
|
5. Set up a system to enable selecting a tag from the preset tags for each line when importing
|
|
6. Modify that to enable creating a new tag and saving that to localstorage
|
|
|
|
### Things for later versions
|
|
|
|
- Sort transactions by date order
|
|
- Be able to handle separate accounts, and split transactions into these
|
|
- Be able to set rules to auto apply these, or manually set them for each item on a statement when adding it in
|
|
- Be able to summarise (with graphs) expenditure and savings for any selected time period
|
|
- Be able to expand the above summaries for more detailed information
|
|
- Be able to calculate your current FIRE status (i.e. how much you save in a year, and, assuming a return of x%, how much your yearly income from investing your savings would be, compounding to calculate how long until you hit a minimum retirement goal - vaguely similar to https://app.fin-dee.com/)
|
|
- Be able to analyse and capture trends in expenditure and saving across months/years
|
|
|
|
## Project setup
|
|
```
|
|
npm install
|
|
```
|
|
|
|
### Compiles and hot-reloads for development
|
|
```
|
|
npm run serve
|
|
```
|
|
|
|
### Compiles and minifies for production
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
### Run your tests
|
|
```
|
|
npm run test
|
|
```
|
|
|
|
### Lints and fixes files
|
|
```
|
|
npm run lint
|
|
```
|
|
|
|
### Customize configuration
|
|
See [Configuration Reference](https://cli.vuejs.org/config/). |