https://github.com/siteddv/simple-bank
Simple bank backend service
https://github.com/siteddv/simple-bank
docker go golang golang-application golang-examples golang-package jwt makefile paseto postgresql rest rest-api sql
Last synced: about 1 month ago
JSON representation
Simple bank backend service
- Host: GitHub
- URL: https://github.com/siteddv/simple-bank
- Owner: siteddv
- Created: 2021-12-12T17:52:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-24T18:07:34.000Z (over 4 years ago)
- Last Synced: 2025-07-09T01:04:44.180Z (11 months ago)
- Topics: docker, go, golang, golang-application, golang-examples, golang-package, jwt, makefile, paseto, postgresql, rest, rest-api, sql
- Language: Go
- Homepage:
- Size: 136 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Simple bank service
The service is a simple bank. It will provide APIs for the frontend to do following things:
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](https://www.docker.com/products/docker-desktop)
- [TablePlus](https://tableplus.com/)
- [Golang](https://golang.org/)
- [Homebrew](https://brew.sh/)
- [Migrate](https://github.com/golang-migrate/migrate/tree/master/cmd/migrate)
```bash
brew install golang-migrate
```
- [Sqlc](https://github.com/kyleconroy/sqlc#installation)
```bash
brew install sqlc
```
- [Gomock](https://github.com/golang/mock)
``` bash
go install github.com/golang/mock/mockgen@v1.6.0
```
### Setup infrastructure
- Create the bank-network
``` bash
make network
```
- Start postgres container:
```bash
make postgres
```
- Create simple_bank database:
```bash
make createdb
```
- Run db migration up all versions:
```bash
make migrateup
```
- Run db migration up 1 version:
```bash
make migrateup1
```
- Run db migration down all versions:
```bash
make migratedown
```
- Run db migration down 1 version:
```bash
make migratedown1
```
### How to generate code
- Generate SQL CRUD with sqlc:
```bash
make sqlc
```
- Generate DB mock with gomock:
```bash
make mock
```
- Create a new db migration:
```bash
migrate create -ext sql -dir db/migration -seq
```
### How to run
- Run server:
```bash
make server
```
- Run test:
```bash
make test
```