Jan Bader
6032f6f526
Some checks failed
continuous-integration/drone/push Build encountered an error
31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
# Budgeteer
|
|
|
|
Budgeting Web-Application written in Go and inspired by [YNAB](https://youneedabudget.com).
|
|
|
|
## Getting started
|
|
|
|
The fastest way to get up and running quickly, is using docker-compose. Just download the [docker-compose.yml](https://git.javil.eu/jacob1123/budgeteer/src/branch/master/docker/docker-compose.yml) to some empty directory and run `docker-compose up -d`. This starts budgeteer, a postgres database and an adminer instance. The latter is optional and can be removed from the docker-compose.yml.
|
|
|
|
## Known issues
|
|
|
|
Currently the application is usable when importing from YNAB via their CSV export. All balances should match the balances from YNAB. There are even unit-tests that confirm that using my personal budget.
|
|
|
|
For people wishing to start fresh in Budgeteer, there currently are some blockers though:
|
|
- The ability to create new accounts and categories is missing (#59)
|
|
|
|
## Data structure
|
|
|
|
1 User
|
|
N Budgets
|
|
AccountID[]
|
|
CategoryID[]
|
|
PayeeID[]
|
|
|
|
N Accounts
|
|
TransactionID[]
|
|
N Categories
|
|
AssignmentID[]
|
|
N Payees
|
|
|
|
N Transactions
|
|
N Assignments |