gohex

README

Gohex

Create project with Hexagonal Architecture folder structure inluding recomendend way with Vertical Slicing

Gohex is a cli tool to create Hexagonal Architecture + Vertical Slicing app for you including gin-gonic, bcrypt and jwt.

• Creates Hexagonal Architecture + Vertical Slicing project for you.

Features

• Hexagonal Architecture + Vertical Slicing Folder Structure (https://en.wikipedia.org/wiki/Hexagonal_architecture_(software))
• Gin Gonic (https://github.com/gin-gonic/gin)
• Swagger (https://github.com/swaggo/gin-swagger)
• Jwt (https://github.com/dgrijalva/jwt-go)
• Bcrypt (https://golang.org/x/crypto/bcrypt)
• Async - Async functions
• Auto add swagger for your endpoint
• Modules - Auto generate module with crud flow
• Database Service - Auto generate db service client
  • Mysql
  • Gorm
• Example tasks api
• Testing (Auto generate e2e test example when creating a new modules)

Installation

Gohex requires Go v1.17+ to run.

Install the dependencies.

go get github.com/saturnavt/gohex

Or

go install github.com/saturnavt/gohex@latest

How to use

In your terminal type to see all avaible commands:

gohex

To create a new gin-gonic with Hexagonal Architecture + Vertical Slicing project(This includes a crud example with the name of Tasks):

▶  New Project
  Module
  DB Service

Enter Project Name: yourprojectname

Modules

To create a new module with crud flow: please use snake_case when the module name consist of two or more words

  New Project
▶  Module
  DB Service

Enter Module Name: your_module_name

Database service

To create a new db service client with Mysql, Gorm or Prisma:

  New Project
  Module
▶  DB Service

Mysql - to learn more visit (https://github.com/go-sql-driver/mysql)

Enter DB(mysql, gorm) Name: mysql

Gorm - to learn more visit (https://github.com/jinzhu/gorm)

Enter DB(mysql, gorm) Name: gorm

This will generate a database connection in data/db.go

For Mysql and Gorm import the service in your repository like for example:

db "yourProjectName/data"

Example for Mysql:

// Insert new tasks
res, err := db.Client().Exec("INSERT INTO tasks VALUES(DEFAULT, 'Title', 'Desc')")
if err != nil {
  fmt.Println("ERROR: ", err)
}
fmt.Println(res)

To learn more visit (https://github.com/go-sql-driver/mysql)

Example for Gorm:

// Insert new tasks
err := db.Client().Save(&tasksEntity.Task{
  Title:       "TEST",
  Description: "This is a description",
})

if err != nil {
  fmt.Println(err)
}

To learn more visit (https://github.com/jinzhu/gorm)

Async

How to use async:

package main

import async "yourProjectName/helpers"

//This functions wait 3 seconds to return 1
func DoneAsync() int {
	fmt.Println("Warming up ...")
	time.Sleep(3 * time.Second)
	fmt.Println("Done ...")
	return 1
}

func main() {
	fmt.Println("Let's start ...")

  //Here you call the function as async function
	future := async.Exec(func() interface{} {
		return DoneAsync()//The function that will await
	}).Await()

	fmt.Println("Done is running ...")
	fmt.Println(future)
}

Swagger

Build your application and after that, go to http://localhost:5000/swagger/index.html , you to see your Swagger UI.

When you create a new module swagger will be added automatically then you only need to modified what you need, but remember each time you modified swagger use the next command

swag init

To learn more visit (https://github.com/swaggo/gin-swagger)

Testing

To run tests use

go test -v ./...

To get coverage

go test -v -cover --coverprofile=coverage.out  -coverpkg=./... ./...

To view test coverage on your browser

go tool cover -html=coverage.out

Total coverage

Windows

go tool cover -func=coverage.out | findstr total:

Linux

go tool cover -func=coverage.out | grep total:

Folder Structure:

│   .env
│   go.mod
│   go.sum
│   main.go
│
├───app
│   └───tasks
│       ├───aplication
│       │       tasks.controller.go
│       │
│       ├───domain
│       │   ├───models
│       │   │       tasks.model.go
│       │   │
│       │   ├───repositories
│       │   │       tasks.repository.go        
│       │   │
│       │   └───services
│       │           tasks.service.go
│       │
│       └───infraestructure
│               tasks.db.go
│
├───bcrypt
│       bcrypt.go
│
├───data
│       db.go
│
├───docs
│       docs.go
│       swagger.json
│       swagger.yaml
│
├───env
│       env.go
│
├───helpers
│       async.go
│       errors.go
│
├───jswt
│       jswt.go
│
├───router
│       router.go
│
└───e2e
    └───tasks
            gettasks_test.go

License

MIT

Gohex is MIT licensed.