https://github.com/chokeguy/simple-bank
A service that provides both RESTful and gRPC APIs to simulate the core functionalities of a basic bank.
https://github.com/chokeguy/simple-bank
aws-ec2 aws-ecs aws-eks aws-elasticache github-actions go grpc rest-api restful-api route53
Last synced: about 2 months ago
JSON representation
A service that provides both RESTful and gRPC APIs to simulate the core functionalities of a basic bank.
- Host: GitHub
- URL: https://github.com/chokeguy/simple-bank
- Owner: ChokeGuy
- License: other
- Created: 2025-01-24T04:19:00.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-18T19:20:08.000Z (about 1 year ago)
- Last Synced: 2025-08-14T16:56:09.247Z (8 months ago)
- Topics: aws-ec2, aws-ecs, aws-eks, aws-elasticache, github-actions, go, grpc, rest-api, restful-api, route53
- Language: Go
- Homepage: https://api.my-simple-bank.org
- Size: 7.17 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Simple Bank
Funtionalities:
- Create and manage bank accounts.
- Record all balance changes to each of the accounts.
- Perform a money transfer between 2 accounts.
## Simple bank service
APIS:
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)
- [Golang](https://golang.org/)
- [Migrate](https://github.com/golang-migrate/migrate/tree/master/cmd/migrate)
```bash
$ curl -L https://packagecloud.io/golang-migrate/migrate/gpgkey | apt-key add -
$ echo "deb https://packagecloud.io/golang-migrate/migrate/ubuntu/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/migrate.list
$ apt-get update
$ apt-get install -y migrate
```
- [DB Docs](https://dbdocs.io/docs)
```bash
npm install -g dbdocs
dbdocs login
```
- [DBML CLI](https://www.dbml.org/cli/#installation)
```bash
npm install -g @dbml/cli
dbml2sql --version
```
- [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 schema SQL file with DBML:
```bash
make db_schema
```
- Generate SQL CRUD with sqlc:
```bash
make sqlc
```
- Generate DB mock with gomock:
```bash
make mock
```
- Create a new db migration:
```bash
make migratecreate name=
```
### How to run
- Run server:
```bash
make server
```
- Run test:
```bash
make test
```