API service

This service provide APIs for the frontend to do following things:

1. Create and manage accounts, which are composed of owner’s name, balance, and currency.
2. Record all balance changes to each of the account, so every time some money is added to or subtracted from the account, an account entry record will be created.
3. Perform a money transfer between 2 accounts. This should happen within a transaction, so that either both accounts’ balance are updated successfully or none of them are.

Setup local environment

Install tools

• Docker desktop

• TablePlus

• Golang

• Homebrew

• Migrate

  brew install golang-migrate
  

• DB Docs

  npm install -g dbdocs
  dbdocs login
  

• DBML CLI

  npm install -g @dbml/cli
  dbml2sql --version
  

• Sqlc

  brew install sqlc
  

• Gomock

  go get github.com/golang/mock/[email protected]
  

Setup infra

• Run db migration up all versions:

  make migrateup
  

• Run db migration up 1 version:

  make migrateup1
  

• Run db migration down all versions:

  make migratedown
  

• Run db migration down 1 version:

  make migratedown1
  

How to generate code

• Generate SQL CRUD with sqlc:

  make sqlc
  

• Generate DB mock with gomock:

  make mock
  

• Create a new db migration:

  make new_migration name=<migration_name>
  

How to run

• Run server and db:

  docker compose up
  

• Run server:

  make server
  

• Run test:

  make test
  

Deploy to Kubernetes cluster

• Install nginx ingress controller:

  kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/controller-v1.12.0-beta.0/deploy/static/provider/aws/deploy.yaml
  

• Install cert-manager:

  kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.4.0/cert-manager.yaml