Go Clean Architecture

Clean Architecture with Gin Web Framework

Features ⭐

• Clean Architecture written in Go
• Application backbone with Gin Web Framework
• Dependency injection using uber-go/fx
• Uses fully featured GORM

Linter setup

Need Python3 to setup linter in git pre-commit hook.

make lint-setup

---

Run application

• Setup environment variables

cp .env.example .env

• Update your database credentials environment variables in .env file
• Setup serviceAccountKey.json. To get one create a firebase project. Go to Settings > Service Accounts and then click "Generate New Private Key". and then confirm by clicking "Generate Key". Copy the key to serviceAccountKey.json file. You can see the example at serviceAccountKey.json.example file.
• Setup STORAGE_BUCKET_NAME in .env. In firebase Go to All products > Storage and then create new storage. STORAGE_BUCKET_NAME is visible at top in files tab as gs://my-app.appspot.com.Here my-app.appspot.com is your bucket name that needs to be in .env file.

Locally

• Run go run main.go app:serve to start the server.
• There are other commands available as well. You can run go run main.go -help to know about other commands available.

Using Docker

Ensure Docker is already installed in the machine.

• Start server using command docker-compose up -d or sudo docker-compose up -d if there are permission issues.

---

Folder Structure 📁

Folder Path	Description
/bootstrap	contains modules required to start the application
/console	server commands, run go run main.go -help for all the available server commands
/docker	docker files required for docker compose
/domain	contains models, constants and folder for each domain with controller, repository, routes and services
/domain/constants	global application constants
/domain/models	ORM models
/domain/<name>	controller, repository, routes and service for a domain. In this template user is a domain
/hooks	git hooks
/migration	database migration files
/pkg	contains setup for api_errors, infrastructure, middlewares, external services, utils
/pkg/api-errors	server error handlers
/pkg/framework	contains env parser, logger...
/pkg/infrastructure	third-party services connections like gmail, firebase, s3-bucket, ...
/pkg/middlewares	all middlewares used in the app
/pkg/responses	different types of http responses are defined here
/pkg/services	service layers, contains the functionality that compounds the core of the application
/pkg/types	data types used throught the application
/pkg/utils	global utility/helper functions
/seeds	seeds for already migrated tables
/tests	includes application tests
.env.example	sample environment variables
dbconfig.yml	database configuration file for sql-migrate command
docker-compose.yml	docker compose file for service application via Docker
main.go	entry-point of the server
Makefile	stores frequently used commands; can be invoked using make command
serviceAccountKey.json.example	sample credentials file for accessing Google Cloud

---

Migration Commands

⚓️   If you want to run the migration runner from the host environment instead of the docker environment; ensure that sql-migrate is installed on your local machine.

Install sql-migrate

You can skip this step if sql-migrate has already been installed on your local machine.

Note: Starting in Go 1.17, installing executables with go get is deprecated. go install may be used instead. Read more

go install github.com/rubenv/sql-migrate/...@latest

If you're using Go version below 1.18

go get -v github.com/rubenv/sql-migrate/...

Running migration

Add argument p=host after make command to run migration commands on local environment

Example:

make p=host migrate-up

Available migration commands

Command	Desc
make migrate-status	Show migration status
make migrate-up	Migrates the database to the most recent version available
make migrate-down	Undo a database migration
make redo	Reapply the last migration
make create	Create new migration file

---

Testing

The framework comes with unit and integration testing support out of the box. You can check examples written in tests directory.

To run the test just run:

go test ./... -v

For test coverage

go test ./... -v -coverprofile cover.txt -coverpkg=./...
go tool cover -html=cover.txt -o index.html

Update Dependencies

Steps to Update Dependencies

1. go get -u
2. Remove all the dependencies packages that has // indirect from the modules
3. go mod tidy

Discovering available updates

List all of the modules that are dependencies of your current module, along with the latest version available for each:

go list -m -u all

Display the latest version available for a specific module:

go list -m -u example.com/theirmodule

Example:

go list -m -u cloud.google.com/go/firestore
cloud.google.com/go/firestore v1.2.0 [v1.6.1]

Getting a specific dependency version

To get a specific numbered version, append the module path with an @ sign followed by the version you want:

go get example.com/theirmodule@v1.3.4

To get the latest version, append the module path with @latest:

go get example.com/theirmodule@latest

Synchronizing your code’s dependencies

go mod tidy

Contribute 👩‍💻🧑‍💻

We are happy that you are looking to improve go clean architecture. Please check out the contributing guide

Even if you are not able to make contributions via code, please don't hesitate to file bugs or feature requests that needs to be implemented to solve your use case.

Authors