Skip to content

Commit f2cf8db

Browse files
author
Javier Ruiz Corisco
authored
chore: update README
1 parent 291fda7 commit f2cf8db

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,50 @@
1-
# Steris
1+
# Steris | Bookkeeping Project
22

33
Wanted to start 2023 taking a look at our finances and since my Credit Suisse app doesn't help me get a good overview decided to build something in a day or two that will help me get a better overview of where I spend my money.
44

55
**TL;DR:** This is just a parser of Credit Suisse transactions that transforms them into something I can store in a database and can make some dashboards regarding how much I spent and where do I spend it.
66

77
## What this does
88

9-
Takes a CSV with all my transactions from 2022 in my bank Credit Suisse in the format they give, which is this:
9+
Takes a CSV with all my 2022 transactions from my bank Credit Suisse in their own format, which is this:
1010

1111
```csv
1212
21.12.2022,"TWINT Payment ,SBB EasyRide App 3000 Bern ,of 20.12.22 at 06:49,SBB EasyRide App,3000 Bern ",7.80,,
1313
```
1414

1515
and transforms them into a JSON full of parsed transactions like this one:
1616

17-
```json
17+
```jsonc
1818
{
1919
"hashedId": "0gy2QEzQGOUfHVSM9WNd7ntdrYvVd/WVHgSr8LMcTts=", // made from trx data to be "unique"
2020
"date": "21.12.2022",
2121
"amount": -780, // avoiding using decimals
2222
"paymentType": "twint",
2323
"category": "public_transportation",
2424
"fullDescription": "TWINT Payment ,SBB EasyRide App 3000 Bern ,of 20.12.22 at 06:49,SBB EasyRide App,3000 Bern"
25-
},
25+
}
2626
```
2727

28-
## Requirements to use it
28+
## How to use it
29+
30+
### Requirements
2931

3032
- `input/2022.csv`
3133
- CSV with all your transactions with the following structure, this works for my case with Credit Suisse, other banks may do it differently:
3234
- `date,description,debit,credit,balance`
3335
- Personally I removed the first 5 lines that are not transactions.
3436
- `input/categories.ts`
3537
- List of keywords in the different categories that will suit your case, this is personal and that is why it is not part of the source code, this is not 100% foolproof but it is good enough for me.
36-
- Find an example on `input/categories.ts.example` regarding how this file should be filled.
38+
- Find an example on `input/categories.ts.example` regarding how this file should be filled.
39+
40+
### Running it
41+
42+
1. `npm install`
43+
2. Make sure to fulfill the Requirements described above.
44+
3. `npm run start`
45+
46+
## Why is it called `Steris`?
47+
48+
<img src="https://user-images.githubusercontent.com/5735272/210235636-bd4cca1c-6314-423d-9395-0485affc0c63.jpg" alt="drawing" width="250"/>
49+
50+
Steris is a character from the Brandon Sanderson's Mistborn books that likes to have everything under control by doing bookkeeping, preparing for the worst, and making long lists with all the possible outcomes.

0 commit comments

Comments
 (0)