From 970a4cf8411b514834ea1f8332c1a04ffecbb3ed Mon Sep 17 00:00:00 2001 From: Josh Creek Date: Sat, 13 Apr 2019 20:30:09 +0100 Subject: [PATCH] Changed data structure and updated readme. --- README.md | 32 ++++++++++++++++++-------------- src/App.vue | 23 ++++++++++++++++++++++- 2 files changed, 40 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 3b4b71f..64b2fe8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,22 @@ # 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 ``` npm install @@ -26,17 +43,4 @@ npm run lint ``` ### Customize configuration -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 \ No newline at end of file +See [Configuration Reference](https://cli.vuejs.org/config/). \ No newline at end of file diff --git a/src/App.vue b/src/App.vue index 111036d..2e0ce4b 100644 --- a/src/App.vue +++ b/src/App.vue @@ -23,13 +23,34 @@ export default { "Date": "", "TransactionTypeDescription": "", "Description": "", - "OutgoingPayment": true, + "IsExpenditure": true, "Amount": 0, "Balance": 0, "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" ] } }