From 6032f6f52642717c8e9ddbd6f0474957545c9012 Mon Sep 17 00:00:00 2001 From: Jan Bader Date: Mon, 25 Jul 2022 23:42:34 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EREADME.md=E2=80=9C=20=C3=A4ndern?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9d0136..36ea43e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ # Budgeteer -Budgeting Web-Application +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