Banking System

A banking system built with Golang, PostgreSQL, Redis, Kubernetes, and GitHub Actions.
Implements robust authentication, authorization (RBAC, ACL, ABAC via Casbin), and scalable infrastructure.

---

Table of Contents

• Features
• Tech Stack
• Getting Started
  • Prerequisites
  • Installation
  • Environment Variables
  • Database & Infrastructure
  • Code Generation
  • Running the Application
  • Testing
• Authorization & Access Control
• API Documentation
• Docker Usage
• Linting
• License

---

Features

• User registration and authentication (JWT)
• Role-based, attribute-based, and access control list authorization (Casbin)
• Account management, transfers, and transaction history
• RESTful API with Swagger documentation
• Database migrations and SQL code generation
• Redis caching
• CI/CD with GitHub Actions
• Docker and Kubernetes ready

---

Tech Stack

• Backend: Golang
• Database: PostgreSQL
• Cache: Redis
• Authorization: Casbin v2 (RBAC, ACL, ABAC)
• Migrations: golang-migrate
• SQL Generation: sqlc
• Testing & Mocking: GoMock
• API Docs: Swagger (swaggo)
• CI/CD: GitHub Actions
• Containerization: Docker, Docker Compose, Kubernetes

---

Getting Started

Prerequisites

• Go >= 1.18
• Docker
• Docker Compose
• Make
• PostgreSQL
• Redis

Installation

Install Required Tools

• Migrate (docs):

  curl -L https://packagecloud.io/golang-migrate/migrate/gpgkey | sudo apt-key add -
  echo "deb https://packagecloud.io/golang-migrate/migrate/ubuntu/ $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/migrate.list
  sudo apt-get update
  sudo apt-get install -y migrate

• Sqlc (docs):

  sudo snap install sqlc

• GoMock (docs):

  go install go.uber.org/mock/mockgen@latest
  export PATH=$PATH:$(go env GOPATH)/bin
  mockgen -version

Environment Variables

Create a .env file in the project root and fill in the following:

ENVIRONMENT=develop
ALLOWED_ORIGINS=http://localhost:3000
DB_SOURCE=postgresql://{{username}}:{{password}}@localhost:5432/{{database_name}}?sslmode=disable
MIGRATION_URL=file://db/migration
REDIS_ADDRESS=localhost:6379
HTTP_SERVER_ADDRESS=0.0.0.0:8080
TOKEN_SYMMETRIC_KEY=2e3c226355a0770689c808684fbdca40
ACCESS_TOKEN_DURATION=15m
REFRESH_TOKEN_DURATION=24h
EMAIL_SENDER_NAME=
EMAIL_SENDER_ADDRESS=
EMAIL_SENDER_PASSWORD=
FRONTEND_DOMAIN=http://localhost:3000

Database & Infrastructure

• Create Docker network:

  make network

• Start PostgreSQL:

  make postgres

• Create database:

  make createdb

• Run migrations:

  make migrateup      # Up all versions
  make migrateup1     # Up 1 version
  make migratedown    # Down all versions
  make migratedown1   # Down 1 version

• Start Redis:

  make redis

Code Generation

• Generate SQL CRUD with sqlc:

  make sqlc

• Create a new DB migration:

  make new_migration name=<migration_name>

• Initialize Go module:

  go mod init github.com/LamThanhNguyen/banking-system

• Install Go packages:

  go get github.com/some/library
  go mod tidy

• Generate DB mocks with GoMock:

  make mock

Running the Application

• Ensure you already install swag:

  go install github.com/swaggo/swag/cmd/swag@latest
  echo 'export PATH="$(go env GOPATH)/bin:$PATH"' >> ~/.bashrc
  source ~/.bashrc
  swag --version
  // go get -u github.com/swaggo/gin-swagger
  // go get -u github.com/swaggo/files

• Run server:

  make server

Testing

• Run tests:

  make test

---

Authorization & Access Control

The API uses Casbin v2 (Postgres-backed) to implement a layered model:

Model	Used for	Example
RBAC	Role‑based default permissions	banker → accounts:create
ACL	One‑off user overrides	audit-bot → accounts:read
ABAC	Attribute rules	Depositor can update their own profile only

---

API Documentation

• Generate Swagger docs:

  swag init -g main.go --output docs

• View docs:
  Visit http://localhost:8080/swagger/index.html after running the server.

---

Docker Usage

• Build and run:

  chmod +x start.sh
  make build-container-local
  make run-container-local

• Run with environment variables:

  docker run --rm --name banking-system-local --network bank-network -p 8080:8080 -e GIN_MODE=release -e PARAM=VALUE banking-system:local

• Docker Compose:

  make run-compose-local
  make stop-compose-local

• Useful Docker commands:

  docker ps
  docker rm {container-name}
  docker rmi {image-id}
  docker container inspect {container-name}
  docker network create {network-name}
  docker network connect {network-name} {container-name}
  docker network ls
  docker network inspect {network-name}
  docker stop $(docker ps -a -q)
  docker rm -f $(docker ps -a -q)
  docker rmi -f $(docker images -aq)

---

Linting

• Install golangci-lint:

  curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/HEAD/install.sh | sh -s -- -b $(go env GOPATH)/bin v2.1.6
  echo 'export PATH="$PATH:$HOME/go/bin"' >> ~/.bashrc
  source ~/.bashrc

• Run linter:

  golangci-lint --version
  golangci-lint run

---

License

This project is licensed under the MIT License.

---