/ledger

A project aimed to use existing banking institutions to overlay "envelope" style budgeting tools.

Primary LanguageTypeScript

ledger

Development

Setup:

Install the following tooling:

  1. go - the main programming language for this project
  2. taskfile - task runner and build tool written in go
  3. docker - container builder and runtime
  4. minikube - local kubernetes development instance ( will install kubectl as well )
  5. kubectl - kubernetes controller
  6. helm - kubernetes package manager
  7. nodejs - javascript runtime for frontend tooling

If you are using homebrew for MacOS or Linux, A Brewfile is checked into this repo for easy setup. If you add to this list, please update the Brewfile

$ brew bundle

Run the app:

  1. Start docker ( OSX: open -a Docker )
  2. Deploy a new database on docker
$ task db:start
  1. Start the web server
$ task web:start
  1. Ensure environment file is correct web/.env ( copy from env.template ).
  2. Navigate to the localhost:{port} printed in the console

Testing

Feature Testing

Feature acceptance testing is done via godog