Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adalinesimonian/finance-sim
Simulates daily transactions in a bank account
https://github.com/adalinesimonian/finance-sim
budget cli command-line finance limited money simple simulation simulator tool
Last synced: 3 days ago
JSON representation
Simulates daily transactions in a bank account
- Host: GitHub
- URL: https://github.com/adalinesimonian/finance-sim
- Owner: adalinesimonian
- License: mit
- Created: 2017-07-21T22:07:37.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T02:33:22.000Z (11 months ago)
- Last Synced: 2024-10-29T01:26:45.106Z (15 days ago)
- Topics: budget, cli, command-line, finance, limited, money, simple, simulation, simulator, tool
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/finance-sim
- Size: 22.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# finance-sim
A simple simulator which simulates what will happen to your bank account on a daily basis given a certain set of transactions and bank fees.
## Usage
First, install `finance-sim`:
```bash
npm i -g finance-sim
```
Then, add your transactions and bank fees to `config.toml`. Here's an example:
```toml
[[bank-fees]]
name = "Overdraft Fee"
entity = "Chase Bank"
amount = -34
if = "balance < 0 && expensesMade"
[[transactions]]
name = "My Paycheque"
entity = "ACME, Co."
amount = 2000
when = "firstnotweekend(monthly(20))"
[[transactions]]
name = "Rent"
entity = "My Landlord"
amount = -1500
when = "monthly(1)"
```
Then run the script:
```bash
# finance-sim [start date] [end date]
finance-sim 3400 2017-1-1 2017-2-1
```
And you'll get output much like this:
```
Sun, 1 January 2017
TRX: -$1,500.00 Rent My Landlord
Ending: $1,900.00
Fri, 20 January 2017
TRX: $2,000.00 My Paycheque ACME, Co.
Ending: $3,900.00
Wed, 1 February 2017
TRX: -$1,500.00 Rent My Landlord
Ending: $2,400.00
```
Run `finance-sim --help` to see more command-line options.
## Licence
MIT