Merge pull request #20 from dung13890/develop

Upgrade version v1.2.0

Author: dung13890

.docker/local/go/Dockerfile

@@ -14,3 +14,4 @@ RUN go mod download
 RUN go install github.com/cosmtrek/air@latest
 RUN go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.52.2
 RUN go install github.com/golang/mock/mockgen@v1.6.0
+RUN go install github.com/dung13890/go-base-gen@latest

.env.example

@@ -2,6 +2,7 @@ APP_ENV=local
 APP_ALLOWED_ORIGIN=*,localhost
 APP_HOST=0.0.0.0:8080
 APP_JWT_KEY=go-clean-architecture
+APP_TIME_ZONE=Asia/Ho_Chi_Minh
 
 DB_CONNECTION=postgres
 DB_HOST=db
@@ -12,6 +13,16 @@ DB_PASSWORD=secret
 DB_SSLMODE=disable
 DB_DEBUG=true
 
+REDIS_HOST=redis
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+
+MAIL_HOST=mailpit
+MAIL_PORT=1025
+MAIL_USERNAME=null
+MAIL_PASSWORD=null
+MAIL_FROM_ADDRESS=hello@example.com
+
 DOCKER_UID=USER_ID
 DOCKER_GID=GROUP_ID
 

.golangci.yaml

@@ -16,13 +16,15 @@ linters:
     - staticcheck # is a go vet on steroids, applying a ton of static analysis checks
     - typecheck # like the front-end of a Go compiler, parses and type-checks Go code
     - unused # checks for unused constants, variables, functions and types
+    - revive # fast, configurable, extensible, flexible, and beautiful linter for go. drop-in replacement of golint.
     ## disabled by default
     - asasalint # checks for pass []any as any in variadic func(...any)
     - asciicheck # checks that your code does not contain non-ASCII identifiers
     - bidichk # checks for dangerous unicode character sequences
     - bodyclose # checks whether HTTP response body is closed successfully
     - cyclop # checks function and package cyclomatic complexity
-    - dupl # tool for code clone detection
+    # - dupl # tool for code clone detection
+    - goerr113 # go linter to check the errors handling expressions
     - durationcheck # checks for two durations multiplied together
     - errname # checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
     - errorlint # finds code that will cause problems with the error wrapping scheme introduced in Go 1.13
@@ -71,9 +73,23 @@ linters:
     - whitespace # detects leading and trailing whitespace
 
 linters-settings:
+  gomnd:
+    ignored-files:
+      'errors/code.go'
+  revive:
+    ignore-generated-header: true
+    severity: error
+    rules:
+      # https://github.com/mgechev/revive#available-rules
+      - name: exported
+      - name: unused-parameter
+      - name: unused-receiver
+      - name: waitgroup-by-value
+
   funlen:
     lines: 270
     statements: 50
+
   gocognit:
     # minimal code complexity to report, 30 by default (but we recommend 10-20)
     min-complexity: 35
@@ -106,6 +122,7 @@ issues:
     - path: _test\.go
       linters:
         - bodyclose
+        - revive
         - scopelint
         - funlen
         - gocognit

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Dũng
+Copyright (c) 2022 dung13890
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -10,10 +10,17 @@ test: ### run test
 	go test -v -race -coverprofile=cover.out -coverpkg=./... ./...
 	go tool cover -func cover.out
 
-.PHONY: build-mock
+.PHONY: go-gen lint test
 # put the files with interfaces you'd like to mock in prerequisites
 # wildcards are allowed
 
 go-gen:
 	@echo "Generating mocks..."
+	rm -rf internal/domain/mock/*_mock.go
 	go generate -x ./internal/...
+	@echo "Generating pkg mocks..."
+	rm -rf pkg/*/mock/*_mock.go
+	go generate -x ./pkg/...
+
+dev:
+	air -c cmd/app/.air.toml

README.md

@@ -1,5 +1,6 @@
 # go-clean-architecture
 ![workflow status](https://github.com/dung13890/go-clean-architecture/actions/workflows/go-ci.yml/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
 
 Codebase for golang use clean architecture.
 
@@ -20,6 +21,7 @@ More at [https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture
 - [Quick start](#quick-start)
 - [Project structure](#project-structure)
 - [Tools Used](#tools-used)
+- [Tools Generate](#tool-generate)
 
 ## Quick start
 Below are some modules included in this project:
@@ -36,6 +38,9 @@ docker compose build
 
 Start development:
 ```bash
+# Install dependencies
+go mod tidy
+
 # Copy env
 cp .env.example .env
 
@@ -90,6 +95,31 @@ curl -X POST 'localhost:8080/api/login' \
 }'
 ```
 
+## Tool Generate
+If you need to generate a code base like this architecture, you can use [go-base-gen](https://github.com/dung13890/go-base-gen) tool.
+You can read more about the tool at [README](https://github.com/dung13890/go-base-gen/blob/master/README.md#usage)
+```bash
+NAME:
+   go-base-gen - Use this tool to generate base code
+
+USAGE:
+   go-base-gen [global options] command [command options] [arguments...]
+
+VERSION:
+   v1.0.0
+
+COMMANDS:
+   project  Generate base code for go project use clean architecture
+   domain   Create new domain in project
+   help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --help, -h     show help
+   --version, -v  print only the version (default: false)
+```
+
+The [go-base-gen](https://github.com/dung13890/go-base-gen) tool was created with the purpose to help developers save their time in creating a project with a clean architecture. The tool will generate the code base for you, you just need to focus on the business logic.
+
 ## Project structure
 ![Clean Architecture](CleanArchitecture.jpeg)
 
@@ -193,3 +223,6 @@ func (hl *roleHandler) Index(c echo.Context) error {
 - [Echo](https://echo.labstack.com)
 - [JWT](https://golang-jwt.github.io/jwt)
 - [cosmtrek/air](https://github.com/cosmtrek/air)
+- [go-base-gen](https://github.com/dung13890/go-base-gen)
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/dung13890)

cmd/app/main.go

@@ -4,6 +4,7 @@ import (
 	"go-app/config"
 	"go-app/internal/app"
 	"go-app/pkg/logger"
+	"time"
 )
 
 func main() {
@@ -13,6 +14,12 @@ func main() {
 	}
 
 	conf := config.GetAppConfig()
+	// Set timezone
+	loc, err := time.LoadLocation(conf.AppTimeZone)
+	if err != nil {
+		logger.Error().Fatal(err)
+	}
+	time.Local = loc
 
 	if err := app.Run(conf); err != nil {
 		logger.Error().Fatal(err)

cmd/migrate/main.go

@@ -4,6 +4,7 @@ import (
 	"go-app/config"
 	"go-app/pkg/logger"
 	"go-app/pkg/postgres"
+	"time"
 )
 
 func main() {
@@ -12,6 +13,15 @@ func main() {
 		logger.Error().Fatal(err)
 	}
 
+	conf := config.GetAppConfig()
+
+	// Set timezone
+	loc, err := time.LoadLocation(conf.AppTimeZone)
+	if err != nil {
+		logger.Error().Fatal(err)
+	}
+	time.Local = loc
+
 	db := config.GetDBConfig()
 
 	if err := postgres.Migrate(db); err != nil {

cmd/seed/main.go

@@ -4,6 +4,7 @@ import (
 	"go-app/config"
 	"go-app/internal/app"
 	"go-app/pkg/logger"
+	"time"
 )
 
 func main() {
@@ -12,6 +13,15 @@ func main() {
 		logger.Error().Fatal(err)
 	}
 
+	conf := config.GetAppConfig()
+
+	// Set timezone
+	loc, err := time.LoadLocation(conf.AppTimeZone)
+	if err != nil {
+		logger.Error().Fatal(err)
+	}
+	time.Local = loc
+
 	dbConfig := config.GetDBConfig()
 	if err := app.Seed(dbConfig); err != nil {
 		logger.Error().Fatal(err)

config/app.go

@@ -13,14 +13,15 @@ type AppConfig struct {
 	AllowedOrigin string `mapstructure:"APP_ALLOWED_ORIGIN"`
 	AppHost       string `mapstructure:"APP_HOST"`
 	AppJWTKey     string `mapstructure:"APP_JWT_KEY"`
+	AppTimeZone   string `mapstructure:"APP_TIME_ZONE"`
 }
 
 // LoadConfig config setting from .env.
 func LoadConfig() error {
 	viper.SetConfigFile(".env")
 
 	if err := viper.ReadInConfig(); err != nil {
-		return errors.Wrap(err)
+		return errors.ErrInternalServerError.Wrap(err)
 	}
 
 	return nil