release(main): create boilerplate app

Author: mathleite

.dockerignore

@@ -0,0 +1,3 @@
+docker-compose.yml
+Dockerfile
+.env*

.env.example

@@ -0,0 +1,7 @@
+POSTGRES_DB=
+POSTGRES_PASSWORD=
+POSTGRES_USER=
+DB_HOST=db
+DB_PORT=5432
+BASE_URL=http://localhost:8000
+APP_SECRET=

.gitignore

@@ -0,0 +1,28 @@
+# BINARIES
+build/
+artifacts/
+bin/
+dist/
+*.exe
+*.out
+
+# DEPENDENCIES
+/vendor/
+/go/pkg/
+
+# LOCAL
+.env
+.local
+
+# IDE
+.idea/
+.vscode/
+
+# LOG
+*.log
+
+# OTHERS
+.DS_Store
+Thumbs.db
+*.cover
+*.cov

Dockerfile

@@ -0,0 +1,23 @@
+FROM golang:alpine3.21 AS builder
+
+WORKDIR /app
+
+COPY . .
+
+RUN go mod download \
+    && CGO_ENABLED=0 GOOS=linux go build -o main ./
+
+# Build a minimal image
+FROM alpine:latest
+
+# Add a non-root user
+RUN addgroup -S appgroup && adduser -S appuser -G appgroup
+USER appuser
+
+WORKDIR /app
+
+COPY --from=builder /app/main /usr/local/bin/main
+
+EXPOSE 8000
+
+CMD ["main"]

README.md

@@ -0,0 +1,100 @@
+# Gin Boilerplate API
+
+`gin-boilerplate-api` is a Go-based microservice designed to handle client-related operations. This API provides endpoints for managing user data and authentication.
+
+## Table of Contents
+
+- [Features](#features)
+- [Getting Started](#getting-started)
+- [API Endpoints](#api-endpoints)
+- [Examples](#examples)
+
+## Features
+
+- RESTful API for client management.
+- Built with Go for high performance and scalability.
+- Easy to integrate with other microservices.
+
+## Getting Started
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/mathleite/gin-boilerplate-api-api.git
+   ```
+2. Navigate to the project directory:
+   ```bash
+   cd gin-boilerplate-api-api
+   ```
+3. Create and fill .env:
+   ```bash
+   cp .env.example .env && \
+   vim .env
+   ```
+4. Run the application:
+   ```bash
+   docker compose up --build --no-cache -d
+   ```
+
+## API Endpoints
+
+### Base URL
+
+```
+http://localhost:8000/api/v1
+```
+
+### Endpoints
+
+- **GET /health**: Application _health-check_.
+- **POST /register**: Register a user.
+- **POST /signin**: SignIn a user.
+- **GET /transactions**: Access a authenticated endpoint _(has no logic here)_.
+
+## Examples
+
+### Create a User
+
+**Request:**
+
+```bash
+curl --request POST \
+  --url http://localhost:8000/api/v1/register \
+  --header 'Content-Type: application/json' \
+  --data '{
+	"name": "Boiler Plate",
+	"email": "me.boilerplate@devlocal.com",
+	"password": "123root"
+}'
+```
+
+### SignIn
+
+**Request:**
+
+```bash
+curl --request POST \
+  --url http://localhost:8000/api/v1/auth/signin \
+  --header 'Content-Type: application/json' \
+  --data '{
+	"email": "me.matheusleite@devlocal.com",
+	"password": "123root"
+}'
+```
+
+**Response:**
+
+```json
+{
+  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NDEzMDUxMTcsImlhdCI6MTc0MTMwMzMxNywidXNlcl9pZCI6ImRiNGI5YWE4LTMwZDMtNDExMy05MjE2LTUwZTE0MTQ2OGQ1NSJ9.ZvUjK32lDg6OTFdNl-OTQDV_2ywcYLAWNWu3V23QYgo"
+}
+```
+
+### "Fetch transactions"
+
+**Request:**
+
+```bash
+curl --request GET \
+  --url http://localhost:8000/api/v1/transactions \
+  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3NDEzMDUxMTcsImlhdCI6MTc0MTMwMzMxNywidXNlcl9pZCI6ImRiNGI5YWE4LTMwZDMtNDExMy05MjE2LTUwZTE0MTQ2OGQ1NSJ9.ZvUjK32lDg6OTFdNl-OTQDV_2ywcYLAWNWu3V23QYgo'
+```

database/base.go

@@ -0,0 +1,13 @@
+package database
+
+import (
+	"time"
+
+	"github.com/google/uuid"
+)
+
+type BaseTable struct {
+	ID        uuid.UUID `gorm:"type:uuid;default:gen_random_uuid();primaryKey" json:"id"`
+	CreatedAt time.Time `json:"created_at" gorm:"default:now()"`
+	UpdatedAt time.Time `json:"updated_at" gorm:"default:now()"`
+}

database/setup.go

@@ -0,0 +1,42 @@
+package database
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"gorm.io/driver/postgres"
+	"gorm.io/gorm"
+	"gorm.io/gorm/logger"
+)
+
+var (
+	Db *gorm.DB
+)
+
+func Setup() {
+	db, err := gorm.Open(postgres.Open(getDatabaseDns()), &gorm.Config{
+		Logger: logger.Default.LogMode(logger.Info),
+	})
+	if err != nil {
+		log.Fatalln("Database connection fails:", err)
+	}
+	Db = db
+	log.Println("Database connection successfully.")
+	migrateDatabase()
+}
+
+func getDatabaseDns() string {
+	host := os.Getenv("DB_HOST")
+	dbname := os.Getenv("POSTGRES_DB")
+	port := os.Getenv("DB_PORT")
+	user := os.Getenv("POSTGRES_USER")
+	pass := os.Getenv("POSTGRES_PASSWORD")
+	return fmt.Sprintf("host=%s user=%s password=%s dbname=%s port=%s", host, user, pass, dbname, port)
+}
+
+func migrateDatabase() {
+	if err := Db.AutoMigrate(&User{}); err != nil {
+		log.Fatal("Fail to migrate database: ", err)
+	}
+}

database/user.go

@@ -0,0 +1,31 @@
+package database
+
+import (
+	"fmt"
+	"strings"
+)
+
+type User struct {
+	BaseTable
+	Name     string `gorm:"not null" json:"name"`
+	Email    string `gorm:"not null;uniqueIndex" json:"email"`
+	Password string `gorm:"not null" json:"password"`
+}
+
+func (u *User) Save() error {
+	if err := Db.Create(&u).Error; err != nil {
+		if strings.Contains(err.Error(), "duplicate key value violates unique constraint") {
+			return fmt.Errorf("e-mail already exists: %s", u.Email)
+		}
+		return fmt.Errorf("fail to save user: %v", err)
+	}
+	return nil
+}
+
+func (u *User) FindByEmail(email string) (*User, error) {
+	var user User
+	if err := Db.Where("email = ?", email).First(&user).Error; err != nil {
+		return nil, fmt.Errorf("user not found: %v", err)
+	}
+	return &user, nil
+}

docker-compose.yml

@@ -0,0 +1,32 @@
+services:
+  db:
+    image: postgres:13.20-alpine3.20
+    restart: always
+    shm_size: 128mb
+    env_file:
+      - .env
+    ports:
+      - "5432:5432"
+    networks:
+      - backend
+
+  transaction-api:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    container_name: transactionApi
+    working_dir: /app
+    volumes:
+      - .:/app
+    ports:
+      - "8000:8000"
+    depends_on:
+      - db
+    networks:
+      - backend
+    env_file:
+      - .env
+
+networks:
+  backend:
+    driver: bridge

go.mod

@@ -0,0 +1,52 @@
+module github.com/mathleite/gin-boilerplate-api
+
+go 1.23.4
+
+require (
+	github.com/gin-gonic/gin v1.10.0
+	github.com/golang-jwt/jwt/v5 v5.2.1
+	github.com/golodash/galidator/v2 v2.0.1
+)
+
+require (
+	github.com/bytedance/sonic v1.12.9 // indirect
+	github.com/bytedance/sonic/loader v0.2.3 // indirect
+	github.com/cloudwego/base64x v0.1.5 // indirect
+	github.com/dlclark/regexp2 v1.7.0 // indirect
+	github.com/gabriel-vasile/mimetype v1.4.8 // indirect
+	github.com/gin-contrib/sse v1.0.0 // indirect
+	github.com/go-playground/locales v0.14.1 // indirect
+	github.com/go-playground/universal-translator v0.18.1 // indirect
+	github.com/go-playground/validator/v10 v10.25.0 // indirect
+	github.com/goccy/go-json v0.10.5 // indirect
+	github.com/golang/protobuf v1.5.0 // indirect
+	github.com/golodash/godash v1.2.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
+	github.com/jackc/pgpassfile v1.0.0 // indirect
+	github.com/jackc/pgservicefile v0.0.0-20240606120523-5a60cdf6a761 // indirect
+	github.com/jackc/pgx/v5 v5.7.2 // indirect
+	github.com/jackc/puddle/v2 v2.2.2 // indirect
+	github.com/jinzhu/copier v0.3.5 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
+	github.com/json-iterator/go v1.1.12 // indirect
+	github.com/klauspost/cpuid/v2 v2.2.9 // indirect
+	github.com/leodido/go-urn v1.4.0 // indirect
+	github.com/mattn/go-isatty v0.0.20 // indirect
+	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
+	github.com/modern-go/reflect2 v1.0.2 // indirect
+	github.com/nyaruka/phonenumbers v1.1.6 // indirect
+	github.com/pelletier/go-toml/v2 v2.2.3 // indirect
+	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
+	github.com/ugorji/go/codec v1.2.12 // indirect
+	golang.org/x/arch v0.14.0 // indirect
+	golang.org/x/crypto v0.34.0 // indirect
+	golang.org/x/net v0.35.0 // indirect
+	golang.org/x/sync v0.11.0 // indirect
+	golang.org/x/sys v0.30.0 // indirect
+	golang.org/x/text v0.22.0 // indirect
+	google.golang.org/protobuf v1.36.5 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+	gorm.io/driver/postgres v1.5.11 // indirect
+	gorm.io/gorm v1.25.12 // indirect
+)