🔨 Add new features like graphql with gqlgen, gin framework, finished restful, update README and docker-compose for just only command

Author: ruyjfs

README.md

@@ -1,10 +1,126 @@
-# example-golang
+# Example Golang
 
 Golang, GraphQL, Resful, Auth JWT example and much more.
 
-##
+A example of bank transaction, made with GOlang, Gin Framework, Restful and GraphQL.
 
+- [Endpoints](#Endpoints)
+- [Insomnia](#Insomnia)
+- [Get Started](#Get-Started)
+- [Get Started - without docker](##Get-Started-without-docker)
+- [Run Debug with VScode and DB in docker](##Run-Debugg)
+- [Unity Test and Test Integration](##Unity-Test-and-Test-Integration)
 - [Step By Step](#Step-By-Step)
+- [Commands](#Commands)
+- [Technologies](#Technologies)
+- [References](#References)
+
+## Endpoints
+
+| Endpoint   | Method | Action  |
+| ---------- | ------ | ------- |
+| /graphql   | POST   |         |
+| /graphiql  | GET    |         |
+| /users     | GET    | Index   |
+| /users     | POST   | Store   |
+| /users     | PATCH  | Update  |
+| /users/:id | DELETE | Destroy |
+| /users/:id | GET    | Show    |
+
+## Insomnia
+
+If you use Insomnia, just import a [insomnia-v4.yaml](insomnia-v4.yaml)
+
+## Get Started
+
+Just one command
+
+```bash
+docker-compose up --build
+```
+
+> Open on you best browser: http://localhost:8085 <br />
+> GraphQL Playground: http://localhost:8085/gaphiql<br />
+> To see a database open adminer on: http://localhost:8086 <br />
+> Configurations for connect on database see: [/docker/local.env](/docker/local.env)
+> IMPORTANT! If you not have a docker see: [Get Started - without docker](#Get-Stared-without-docker)
+
+## Structure
+
+```
+├── config - (configuration)
+├── controllers (RESTfull methods)
+├── core (Base methos for controllers, models and services)
+├── database - (database configuration, migrate and seed data)
+├── graphql
+│   ├── generated            - A package that only contains the generated runtime
+│   │   └── generated.go
+│   ├── model                - A package for all your graph models, generated or otherwise
+│   │   └── models_gen.go
+│   ├── resolver.go          - The root graph resolver type. This file wont get regenerated
+│   ├── schema.graphqls      - Some schema. You can split the schema into as many graphql files as you like
+│   └── schema.resolvers.go  - the resolver implementation for schema.graphql
+├── models (ORM models based on Database tables)
+├── routes (files with routes)
+├── services (with business rules and intermediate a database)controlling the generated code.
+├── go.mod
+├── go.sum
+├── gqlgen.yml               - The gqlgen config file, knobs for
+└── main.go                  - The entry point to your app. Customize it however you see fit
+```
+
+## Commands
+
+Enter on docker container to exec any command.
+
+```bash
+docker exec -it labbankgo-api /bin/bash
+```
+
+To generate graphql files.
+
+```bash
+gqlgen generate
+```
+
+> On docker
+
+```bash
+~/go/bin/gqlgen generate
+```
+
+> Out of docker
+
+#### Get Started without docker
+
+> A Database PostgreSQL is needed, configurations for it in docker/local.env
+
+```bash
+gin --port=8080 #or ~/go/bin/gin --port=8080
+```
+
+## Run Debugg
+
+> With VScode and SGBD on Docker
+
+```bash
+docker-compose -f docker-compose-db.yml up
+```
+
+> Open your debug on VScode and run "Launch file"
+
+## Unity Test and Test Integration
+
+```bash
+go test -v ./src/tests/
+```
+
+With code coverage
+
+```bash
+go test -cover -coverprofile=c.out ./src/tests/
+go tool cover -html=c.out -o coverage.html
+```
 
 ## Step By Step
 
@@ -45,6 +161,40 @@ Run to see you first hello world
 go run main.go
 ```
 
+### Install Gin Framework
+
+```bash
+go get github.com/codegangsta/gin
+```
+
+Update a file `main.go` with this example code
+
+```bash
+package main
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+)
+
+func setupRouter() *gin.Engine {
+	r := gin.Default()
+
+	r.GET("/:name", func(c *gin.Context) {
+		name := c.Params.ByName("name")
+		c.String(http.StatusOK, "Hello World", name)
+	})
+
+	return r
+}
+
+func main() {
+	r := setupRouter()
+	r.Run(":8080")
+}
+```
+
 ### Install GraphQL
 
 ```bash
@@ -62,3 +212,64 @@ gqlgen generate
 ```bash
 ~/go/bin/gqlgen generate
 ```
+
+Install GORM
+
+```bash
+go get -u gorm.io/gorm && \
+go get -u gorm.io/driver/postgres
+```
+
+Start project with Hot Reload
+
+```bash
+~/go/bin/gin
+```
+
+Default start project
+
+```bash
+go run main.go
+```
+
+> Open on you best browser: http://localhost:8085
+
+## Run Debugg
+
+> With VScode and SGBD on Docker
+
+```bash
+docker-compose -f docker-compose-db.yml up
+```
+
+## Unity Test and Test Integration
+
+```bash
+go test -v ./src/tests/
+```
+
+With code coverage
+
+```bash
+go test -cover -coverprofile=c.out ./src/tests/
+go tool cover -html=c.out -o coverage.html
+```
+
+## Technologies:
+
+- [Golang (Language)](https://golang.org)
+- [GORM (ORM)](https://gorm.io/docs/index.html)
+- [Gqlgen (GraphQL)](https://gqlgen.com)
+- [PostgreSQL (SGBD)](https://www.postgresql.org/docs/online-resources/)
+- [Docker Compose (Local Environment)](https://docs.docker.com/compose/compose-file/)
+
+## References
+
+- [Effective GO](https://golang.org/doc/effective_go.html)
+- [JsonAPI (Restful API Specification)](https://jsonapi.org)
+- [Style Guide - GOlang Code Review](https://github.com/golang/go/wiki/CodeReviewComments)
+- [Style Guide - Google](https://google.github.io/styleguide/)
+- [Style Guide - Uber GO](https://github.com/uber-go/guide/blob/master/style.md/)
+- [Style Guide - Source Graph](https://about.sourcegraph.com/handbook/engineering/languages/go/)
+- [How to GraphQL with GO](https://www.howtographql.com/graphql-go/0-introduction/)
+- [Examples with GO](https://gobyexample.com/)

controllers/user.go

@@ -0,0 +1,54 @@
+package controllers
+
+import (
+	"net/http"
+	"strconv"
+
+	"github.com/gin-gonic/gin"
+	"github.com/ruyjfs/example-golang/config"
+	"github.com/ruyjfs/example-golang/core"
+	"github.com/ruyjfs/example-golang/models"
+	"github.com/ruyjfs/example-golang/services"
+)
+
+type User struct {
+	core.Controller
+}
+
+func (a *User) Index(c *gin.Context) {
+	var params *models.User
+	c.BindJSON(&params)
+	// c.ShouldBind(&params)
+	result, list := new(services.Users).All(params)
+	a.Json(c, result, list)
+}
+
+func (a *User) Store(c *gin.Context) {
+	var params *models.User
+	c.BindJSON(&params)
+	result, data := new(services.Users).Create(params)
+	a.Json(c, result, data)
+}
+
+func (a *User) Update(c *gin.Context) {
+	var params *models.User
+	c.BindJSON(&params)
+	result, data := new(services.Users).Update(params)
+	a.Json(c, result, data)
+}
+
+func (a *User) Destroy(c *gin.Context) {
+	id, err := strconv.Atoi(c.Params.ByName("id"))
+	if err == nil {
+		result, data := new(services.Users).Delete(id)
+		a.Json(c, result, data)
+		return
+	}
+	a.JsonFail(c, http.StatusBadRequest, "Not have params")
+}
+
+func (a *User) Show(c *gin.Context) {
+	var account models.User
+	result := config.Db().First(&account, c.Params.ByName("id"))
+	a.Json(c, result, account)
+}

core/controller.go

@@ -0,0 +1,35 @@
+package core
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+	"gorm.io/gorm"
+)
+
+type Controller struct {
+}
+
+func (controller *Controller) Json(c *gin.Context, result *gorm.DB, data interface{}) {
+	if result.Error == nil {
+		controller.JsonSuccess(c, http.StatusOK, gin.H{"data": data})
+		return
+	}
+	controller.JsonFail(c, http.StatusBadRequest, result.Error.Error())
+	return
+}
+
+func (controller *Controller) JsonSuccess(c *gin.Context, status int, h gin.H) {
+	h["status"] = "success"
+	c.JSON(status, h)
+	return
+}
+
+func (controller *Controller) JsonFail(c *gin.Context, status int, message string) {
+	c.JSON(status, gin.H{
+		"status":  "fail",
+		"message": message,
+		"data":    nil,
+		"code":    status,
+	})
+}

core/model.go

@@ -1,10 +1,19 @@
 package core
 
-import "time"
+import (
+	"time"
+
+	"github.com/ruyjfs/example-golang/config"
+	"gorm.io/gorm"
+)
 
 type Model struct {
 	ID        int        `json:"id" gorm:"primarykey"`
 	CreatedAt time.Time  `json:"createdAt,omitempty"`
 	UpdatedAt time.Time  `json:"updatedAt,omitempty"`
 	DeletedAt *time.Time `json:"deletedAt,omitempty" gorm:"index"`
 }
+
+func (m *Model) Db() *gorm.DB {
+	return config.Db()
+}

core/resolver.go

@@ -0,0 +1,13 @@
+package core
+
+import (
+	"github.com/ruyjfs/example-golang/config"
+	"gorm.io/gorm"
+)
+
+type Resolver struct {
+}
+
+func (r *Resolver) Db() *gorm.DB {
+	return config.Db()
+}

core/service.go

@@ -1,8 +1,17 @@
 package core
 
+import (
+	"github.com/ruyjfs/example-golang/config"
+	"gorm.io/gorm"
+)
+
 type Service struct {
 }
 
+func (m *Service) Db() *gorm.DB {
+	return config.Db()
+}
+
 func (s *Service) Find(m interface{}) {
 
 }

database/seed.go

@@ -0,0 +1,13 @@
+package database
+
+import (
+	"log"
+
+	"github.com/ruyjfs/example-golang/database/seeds"
+)
+
+func Seeder() {
+	log.Printf("Seed: Start")
+	seeds.Perfils()
+	log.Printf("Seed: Success")
+}