init project

Author: 1Caxz

.env.example

@@ -0,0 +1,30 @@
+APP_NAME=Govel-SQL
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=false
+APP_PORT=8000
+APP_TIMEZONE=Asia/Jakarta
+APP_LOCALE=id
+
+DB_CONNECTION=mysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_DATABASE=goveldb
+DB_USERNAME=root
+DB_PASSWORD=
+DB_TIMEZONE=Asia/Jakarta
+
+MAIL_MAILER=smtp
+MAIL_HOST=smtp.example.com
+MAIL_PORT=587
+MAIL_USERNAME=[email protected]
+MAIL_PASSWORD=example
+MAIL_ENCRYPTION=tls
+
+CACHE_DRIVER=redis
+
+REDIS_HOST=127.0.0.1
+REDIS_PASSWORD=null
+REDIS_PORT=6379
+REDIS_CLIENT=predis
+REDIS_CACHE_DB=0

.gitignore

@@ -0,0 +1,20 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+.env
+main
+migrate
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+vignoring
+
+# Dependency directories (remove the comment below to include it)
+# vendor/

README.md

@@ -0,0 +1,138 @@
+# Govel
+Go clean architecture adopted from Laravel.
+
+Main layer: Entity -> Repository -> Service -> Controller
+
+## Features
+- [x] Support `mysql`, `postgres`, `sqlite`, `sqlserver` databases
+- [x] Support ORM database
+- [x] Support database migration
+- [x] Support fake data
+
+## Main Packages
+- [x] Gorm: The fantastic ORM library for Golang, aims to be developer friendly. `github.com/go-gorm/gorm`
+- [x] Fiber: The fastest HTTP engine for Go. `github.com/gofiber/fiber`
+
+## Builds
+Build project based on your system:
+- `make linux-build` for linux system
+- `make mac-build` for macOs darwin system
+- `make migrate-linux-build` build migrate only for linux system
+- `make migrate-mac-build` build migrate only for macOs darwin system
+
+## Database Migration
+After build, use these commands:
+- Use command `./migrate start` to start migration
+- Use command `./migrate seed` to create fake data
+
+## Declaring Models
+Govel using `gorm` package to manage the database. Please follow this docs for more https://gorm.io/docs/models.html
+```go
+type User struct {
+	ID              uint   `gorm:"primaryKey"`
+	SocialId        string `gorm:"type:varchar(255);unique;default:null"`
+	Email           string `gorm:"type:varchar(255);unique;not null"`
+	Password        string `gorm:"type:varchar(255);default:null"`
+	EmailVerifiedAt time.Time
+	Nick            string `gorm:"type:varchar(50);unique;not null"`
+	Name            string `gorm:"type:varchar(255);not null"`
+	Pic             string `gorm:"type:varchar(255);not null;default:/assets/static/user.png"`
+	Location        string `gorm:"type:varchar(255);default:Indonesia"`
+	Desc            string `gorm:"type:varchar(255);default:null"`
+	Role            int    `gorm:"type:tinyint(2);default:1"`
+	Status          int    `gorm:"type:tinyint(2);default:0"`
+	ApiToken        string `gorm:"type:varchar(80);default:null"`
+	RememberToken   string `gorm:"type:varchar(100);default:null"`
+	CreatedAt       time.Time
+	UpdatedAt       time.Time
+	DeletedAt       gorm.DeletedAt `gorm:"index"`
+}
+```
+
+## Migration
+Register your table entity to the migration `database/migration/migrator.go`.
+```go
+func Migrator(db *gorm.DB) {
+	db.AutoMigrate(&entity.User{})
+	db.AutoMigrate(&entity.AnotherTable{})
+}
+```
+Build the project and run command `migration start`.
+
+## Seeder With Faker
+Setup your fake data `database/seeder/seeder.go`.
+```go
+func Seeder(db *gorm.DB) {
+	for i := 0; i < 30; i++ {
+		hashed, err := bcrypt.GenerateFromPassword([]byte(faker.Word()), bcrypt.DefaultCost)
+		exception.PanicIfNeeded(err)
+		db.Create(&entity.User{
+			Email:    faker.Word() + "@gmail.com",
+			Password: string(hashed),
+			Name:     faker.Word(),
+			Nick:     faker.Word(),
+			Role:     1,
+			Status:   1,
+		})
+	}
+}
+```
+
+## Route
+Like laravel, you can add your route in `route/api.go` or `route/web.go`.
+
+For more docs follow this `https://docs.gofiber.io/guide/routing`
+```go
+route.Post("/create", userController.Create)
+route.Get("/show/:id", userController.Show)
+```
+
+Or you can register your controller directly:
+```go
+func APIRoute(route fiber.Router, database *gorm.DB) {
+	// Setup Repository
+	userRepository := repository.NewUserRepository(database)
+
+	// Setup Service
+	userService := service.NewUserService(&userRepository)
+
+	// Setup Controller
+	userController := controller.NewUserController(&userService)
+	userController.Route(route)
+}
+```
+And define your route from controller:
+```go
+func (controller *UserController) Route(route fiber.Router) {
+	group := route.Group("/users")
+	group.Post("/all", controller.All)
+	group.Post("/create", controller.Create)
+	group.Post("/update/:id", controller.Update)
+	group.Post("/delete/:id", controller.Delete)
+}
+```
+
+## Middleware
+There are 3 default middleware:
+- [x] APPMiddleware: affect all routes including api and web.
+- [x] APIMiddleware: affect api route only.
+- [x] WebMiddleware: affect web route only.
+
+You can create your own route and register the middleware:
+```go
+route.Use("/users", middleware.Authenticate)
+```
+For more docs follow this `https://docs.gofiber.io/guide/routing#middleware`
+
+## Access Database from Controller
+You can access the database object from fiber context in the controller directly. But this is not recommended.
+```go
+func (ctx *UserController) Example(c *fiber.Ctx) error {
+	// Access the database object from fiber context
+	db := c.Locals("DB").(*gorm.DB)
+
+	result := map[string]interface{}{}
+	db.Table("users").Where("id = ?", 1).Take(&result)
+	return c.Status(200).JSON(result)
+}
+```

app/entity/user.go

@@ -0,0 +1,27 @@
+package entity
+
+import (
+	"time"
+
+	"gorm.io/gorm"
+)
+
+type User struct {
+	ID              uint   `gorm:"primaryKey"`
+	SocialId        string `gorm:"type:varchar(255);unique;default:null"`
+	Email           string `gorm:"type:varchar(255);unique;not null"`
+	Password        string `gorm:"type:varchar(255);default:null"`
+	EmailVerifiedAt *time.Time
+	Nick            string `gorm:"type:varchar(50);unique;not null"`
+	Name            string `gorm:"type:varchar(255);index:,class:FULLTEXT;not null"`
+	Pic             string `gorm:"type:varchar(255);not null;default:/assets/static/user.png"`
+	Location        string `gorm:"type:varchar(255);default:Indonesia"`
+	Desc            string `gorm:"type:varchar(255);default:null"`
+	Role            int    `gorm:"type:tinyint(2);default:1"`
+	Status          int    `gorm:"type:tinyint(2);default:0"`
+	ApiToken        string `gorm:"type:varchar(80);default:null"`
+	RememberToken   string `gorm:"type:varchar(100);default:null"`
+	CreatedAt       time.Time
+	UpdatedAt       time.Time
+	DeletedAt       gorm.DeletedAt `gorm:"index"`
+}

app/exception/error.go

@@ -0,0 +1,13 @@
+package exception
+
+func PanicIfNeeded(err interface{}) {
+	if err != nil {
+		panic(err)
+	}
+}
+
+func PanicResponse(msg string) {
+	panic(ValidationError{
+		Message: msg,
+	})
+}

app/exception/handler.go

@@ -0,0 +1,24 @@
+package exception
+
+import (
+	"govel/app/model"
+
+	"github.com/gofiber/fiber/v2"
+)
+
+func ErrorHandler(ctx *fiber.Ctx, err error) error {
+	_, ok := err.(ValidationError)
+	if ok {
+		return ctx.Status(400).JSON(model.WebResponse{
+			Code:    400,
+			Message: "BAD_REQUEST",
+			Data:    err.Error(),
+		})
+	}
+
+	return ctx.Status(500).JSON(model.WebResponse{
+		Code:    500,
+		Message: "INTERNAL_SERVER_ERROR",
+		Data:    err.Error(),
+	})
+}

app/exception/validation.go

@@ -0,0 +1,9 @@
+package exception
+
+type ValidationError struct {
+	Message string
+}
+
+func (validationError ValidationError) Error() string {
+	return validationError.Message
+}