Simple Bank

This repository contains code for a simple bank service written completely in Go, supporting the following operations:

1. Create and manage bank 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 development

Install tools

• Docker desktop

• TablePlus

• Golang

• Homebrew

• Migrate

  brew install golang-migrate

• Sqlc

  brew install sqlc

• Gomock

  go install github.com/golang/mock/mockgen@v1.6.0

Setup infrastructure

• Start postgres container:

  make postgres

• Create simple_bank database:

  make createdb

• 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

Documentation

• DB Schema:

  https://dbdiagram.io/d/Simple-Bank-650d067f02bd1c4a5e0e347d

• API Schema:

  https://github.com/viralparmarme/simple-bank/blob/main/postman.json

How to generate code

• Generate SQL CRUD with sqlc:

  make sqlc

• Generate DB mock with gomock:

  make mock

How to run

• Run server:

  make server

• Run test:

  make test