go-clean-architecture - GitLite

KO | EN

gitlite — search

#ai #typescript #llm #golang #machine-learning #rust #linux #docker #java #awesome #cli #kubernetes #awesome-list #mcp

go-clean-architecture

(★ 746)

Simple API for banking routines using a Clean Architecture in Golang :credit_card: :moneybag: :money_with_wings:

File Explorer

Download Latest Version (.zip)

- - ci.yml
- - init.js
- - init.sql
- - logger.go
- - create_account.go
  - create_account_test.go
  - create_transfer.go
  - create_transfer_test.go
  - find_account_balance.go
  - find_account_balance_test.go
  - find_all_account.go
  - find_all_account_test.go
  - find_all_transfer.go
  - find_all_transfer_test.go
- - account_mongodb.go
  - account_postgres.go
  - nosql.go
  - sql.go
  - transfer_mongodb.go
  - transfer_postgres.go
- - validator.go
- account.go
- account_test.go
- money.go
- transfer.go
- uuid.go
- - config.go
  - factory_nosql.go
  - factory_sql.go
  - mongo_handler.go
  - mongo_handler_deprecated.go
  - postgres_handler.go
- - factory.go
  - logger_mock.go
  - logrus.go
  - zap.go
- - factory.go
  - gin.go
  - gorilla_mux.go
- - factory.go
  - go_playground.go
- http_server.go
- create_account.go
- create_account_test.go
- create_transfer.go
- create_transfer_test.go
- find_account_balance.go
- find_account_balance_test.go
- find_all_account.go
- find_all_account_test.go
- find_all_transfer.go
- find_all_transfer_test.go
.dockerignore
.env.example
.gitignore
.travis.yml
clean.png
create_account.png
docker-compose.yml
Dockerfile
go.mod
go.sum
LICENSE
main.go
Makefile
README.md

# Installation Guide

1. Get the code

git clone https://github.com/GSabadini/go-clean-architecture

Downloads the entire project code from GitHub to your computer.

cd go-clean-architecture

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Go

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

4. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make init

Compiles the code based on the generated build configuration to produce an executable.

make up

Compiles the code based on the generated build configuration to produce an executable.

make test

Compiles the code based on the generated build configuration to produce an executable.

make test-local

Compiles the code based on the generated build configuration to produce an executable.

make test-report

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Welcome to Go Clean Architecture</h1>
<p>
  <img alt="Version" src="https://img.shields.io/badge/version-1.11.0-blue.svg?cacheSeconds=2592000" />
  <a href="https://goreportcard.com/badge/github.com/GSabadini/go-clean-architecture" target="_blank">
    <img alt="Build" src="https://goreportcard.com/badge/github.com/GSabadini/go-clean-architecture" />
  </a>
  <a href="#" target="_blank">
    <img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-yellow.svg" />
  </a>
  <a href="https://travis-ci.org/github/GSabadini/go-clean-architecture" target="_blank">
    <img alt="Build" src="https://app.travis-ci.com/GSabadini/go-clean-architecture.svg?branch=master" />
  </a>
  <a href="https://github.com/GSabadini/go-clean-architecture/actions" target="_blank">
    <img src="https://github.com/GSabadini/go-clean-architecture/workflows/test/badge.svg" />
  </a>
  <a href="https://codecov.io/gh/GSabadini/go-clean-architecture">
    <img src="https://codecov.io/gh/GSabadini/go-clean-architecture/graph/badge.svg?token=GAbOSycMO4"/>
  </a>
</p>

- The Go Clean Architecture is a user-friendly solution designed for a range of banking tasks, including account creation, account listing, checking the balance of specific accounts, facilitating transfers between accounts, and compiling transfer records.

## Architecture
-  This represents an endeavor to implement a clean architecture. In the event that you're not yet familiar with it, I'd like to provide you with a [reference](https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html).

![Clean Architecture](https://raw.githubusercontent.com/GSabadini/go-clean-architecture/master/clean.png)

## Example create account use case

![Clean Architecture](https://raw.githubusercontent.com/GSabadini/go-clean-architecture/master/create_account.png)

## Requirements/dependencies
- Docker
- Docker-compose

## Getting Started

- Environment variables

```sh
make init
```

- Starting API in development mode

```sh
make up
```

- Run tests in container

```sh
make test
```

- Run tests local (it is necessary to have golang installed)

```sh
make test-local
```

- Run coverage report

```sh
make test-report
```
```sh
make test-report-func
```

- View logs

```sh
make logs
```

## API Request

| Endpoint        | HTTP Method           | Description       |
| --------------- | :---------------------: | :-----------------: |
| `/v1/accounts` | `POST`                | `Create accounts` |
| `/v1/accounts` | `GET`                 | `List accounts`   |
| `/v1/accounts/{{account_id}}/balance`   | `GET`                |    `Find balance account` |
| `/v1/transfers`| `POST`                | `Create transfer` |
| `/v1/transfers`| `GET`                 | `List transfers`  |
| `/v1/health`| `GET`                 | `Health check`  |

## Test endpoints API using curl

- #### Creating new account

`Request`
```bash
curl -i --request POST 'http://localhost:3001/v1/accounts' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Test",
    "cpf": "070.910.584-24",
    "balance": 100
}'
```

`Response`
```json
{
    "id":"5cf59c6c-0047-4b13-a118-65878313e329",
    "name":"Test",
    "cpf":"070.910.584-24",
    "balance":1,
    "created_at":"2020-11-02T14:50:46Z"
}
```
- #### Listing accounts

`Request`
```bash
curl -i --request GET 'http://localhost:3001/v1/accounts'
```

`Response`
```json
[
    {
        "id": "5cf59c6c-0047-4b13-a118-65878313e329",
        "name": "Test",
        "cpf": "070.910.584-24",
        "balance": 1,
        "created_at": "2020-11-02T14:50:46Z"
    }
]
```

- #### Fetching account balance

`Request`
```bash
curl -i --request GET 'http://localhost:3001/v1/accounts/{{account_id}}/balance'
```

`Response`
```json
{
    "balance": 1
}
```

- #### Creating new transfer

`Request`
```bash
curl -i --request POST 'http://localhost:3001/v1/transfers' \
--header 'Content-Type: application/json' \
--data-raw '{
	"account_origin_id": "{{account_id}}",
	"account_destination_id": "{{account_id}}",
	"amount": 100
}'
```

`Response`
```json
{
    "id": "b51cd6c7-a55c-491e-9140-91903fe66fa9",
    "account_origin_id": "{{account_id}}",
    "account_destination_id": "{{account_id}}",
    "amount": 1,
    "created_at": "2020-11-02T14:57:35Z"
}
```

- #### Listing transfers

`Request`
```bash
curl -i --request GET 'http://localhost:3001/v1/transfers'
```

`Response`
```json
[
    {
        "id": "b51cd6c7-a55c-491e-9140-91903fe66fa9",
        "account_origin_id": "{{account_id}}",
        "account_destination_id": "{{account_id}}",
        "amount": 1,
        "created_at": "2020-11-02T14:57:35Z"
    }
]
```

## Git workflow
- Gitflow

## Code status
- Development

## Author
- Gabriel Sabadini Facina - [GSabadini](https://github.com/GSabadini)

## License
Copyright © 2020 [GSabadini](https://github.com/GSabadini).
This project is [MIT](LICENSE) licensed.