Changed data structure and updated readme.

This commit is contained in:
Josh Creek
2019-04-13 20:30:09 +01:00
parent 26d71fd3b7
commit 970a4cf841
2 changed files with 40 additions and 15 deletions
+17 -13
View File
@@ -1,5 +1,22 @@
# bank-statement-analyser # 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 setup ## Project setup
``` ```
npm install npm install
@@ -27,16 +44,3 @@ npm run lint
### Customize configuration ### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/). See [Configuration Reference](https://cli.vuejs.org/config/).
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
+22 -1
View File
@@ -23,13 +23,34 @@ export default {
"Date": "", "Date": "",
"TransactionTypeDescription": "", "TransactionTypeDescription": "",
"Description": "", "Description": "",
"OutgoingPayment": true, "IsExpenditure": true,
"Amount": 0, "Amount": 0,
"Balance": 0, "Balance": 0,
"Tags": [] "Tags": []
} }
] ]
} }
],
tagsExpenditure: [
"Appearance",
"Bills - Car",
"Bills - Home",
"Bills - Subscriptions",
"Eating out",
"Enjoyment",
"Family",
"Home",
"Insurance",
"One-off or other",
"Repayments",
"Savings",
"Transfers",
"Transport"
],
tagsIncome: [
"Other",
"Savings",
"Wages"
] ]
} }
} }