add: containerize configure

Author: virakthaka

.env.example

@@ -1,5 +1,7 @@
 PORT=8000
+RATE_LIMIT=100
 IDLE_TIMEOUT=5
+FAILED_ATTEMPS=5
 ENABLE_PRINT_ROUTE=true
 
 APP_ENV=local
@@ -10,13 +12,14 @@ LOG_LEVEL=debug
 
 DB_HOST=localhost
 DB_PORT=4000
-DB_USER=root
+DB_USER=xxxx
 DB_PASSWORD=
-DB_NAME=test
+DB_NAME=xxxx
 DB_USE_SSL=false
 DB_AUTO_MIGRATE=true
 
 REDIS_ADDR=localhost
 REDIS_PORT=6379
 
-JWT_SECRET=c62028e29ccec50c690c3579ea5f87b4f5cfa92bd4cf039ae0b05975b8cbc1b4
+JWT_SECRET=xxxxxxxxxxx
+AES_KEY=xxxxxx

Dockerfile

@@ -0,0 +1,11 @@
+FROM alpine:latest
+
+WORKDIR /app
+
+RUN apk --no-cache add ca-certificates
+
+COPY bin/app .
+COPY .env .
+
+EXPOSE 8000
+CMD ["./app"]

README.md

@@ -1,20 +1,21 @@
 # Golang CRUD Service
 
-This is a sample CRUD service built with Golang, demonstrating a layered architecture that separates concerns into handler, service, repository, and model layers. The project uses **TiDB** as the relational database, **Redis** for caching and other in-memory operations, and **JWT** for authentication.
+This is a sample CRUD service built with **Golang**, demonstrating a layered architecture that separates concerns into handler, service, repository, and model layers. The project uses **TiDB** as the relational database, **Redis** for `caching` and `pub/sub` in-memory operations, and **JWT** for authentication.
 
 ## 🚀 Project Purpose
 
-Build a sample CRUD service API with Golang to showcase clean code structure and common best practices in web API development.
+Build a sample CRUD service API with Golang to showcase code structure and common best practices in web API development.
 
 ## 🛠️ Tech Stack
 
 - **[Golang](https://golang.org)** — Core programming language
 - **[Fiber](https://gofiber.io)** — Fast HTTP router
 - **[GORM](https://gorm.io)** — ORM for database operations
 - **[TiDB](https://www.pingcap.com)** — Distributed SQL database
-- **[Redis](https://redis.io)** — In-memory data store
 - **[Validator](https://github.com/go-playground/validator)** — Input validation
 - **[Copier](https://github.com/jinzhu/copier)** — Object copying for DTOs
+- **[Redis](https://redis.io)** — Distributed In-memory data caching
+- **[Redis Stream](https://redis.io/docs/latest/develop/data-types/streams)** — Background task queue using consumer group
 - **[JWT](https://github.com/golang-jwt/jwt)** — JSON Web Token implementation for authentication
 
 ## 📁 Project Structure
@@ -24,19 +25,22 @@ Build a sample CRUD service API with Golang to showcase clean code structure and
 │   └── app/
 │       └── main.go                # Application entry point
 ├── pkg/                           # Shared package configure
-│   └── crypto/
-│       └── aes.go                 # Advanced Encryption Standard encryption
-│       └── bcrypt.go              # Bcrypt hashing
-│   └── redis/
-│       └── redis.go               # Redis configuration
+│   ├── crypto/
+│   │   ├── aes.go                 # Advanced Encryption Standard
+│   │   └── bcrypt.go              # Bcrypt hashing
+│   ├── redis/
+│   │   └── redis.go               # Redis configuration
 │   └── db/
 │       └── db.go                  # DB configuration
 ├── api/
+│   ├── auth/
+│   │   ├── routes.go              # User authenticate-related endpoints
+│   │   └── handler.go             # Logic for handling auth API requests
 │   └── student/
-│       ├── route.go               # Student-related endpoints
+│       ├── routes.go              # Student-related endpoints
 │       └── handler.go             # Logic for handling student API requests
 ├── internal/
-│   ├── middleware/                # HTTP middleware (e.g., auth, logging)
+│   ├── middleware/                # HTTP middleware (e.g., auth, rate limit, logging)
 │   ├── repository/                # Data access layer (calls GORM & queries DB)
 │   ├── service/                   # Business logic, called from handler
 │   ├── model/                     # Database models/entities
@@ -46,9 +50,11 @@ Build a sample CRUD service API with Golang to showcase clean code structure and
 ## 📌 Key Concepts
 
 - **Layered Architecture**: Divides the project into clear layers for maintainability and scalability.
+- **Goroutines**: Background task workers use `goroutines` to run concurrently and process `redis stream` jobs efficiently.
+- **Rate Limit**: Failed attempts and request limited using `redis` to prevent abuse `429 Too Many Requests`.
 - **DTO Pattern**: Uses `copier` to map between internal models and request/response structures.
 - **Validation**: Ensures request payloads are validated with `go-playground/validator`.
-- **ORM**: Leverages GORM to interact with TiDB in a concise and type-safe way.
+- **ORM**: Leverages `GORM` to interact with `TiDB` in a concise and type-safe way.
 
 ## 🧪 Running the Project
 
@@ -63,10 +69,19 @@ Build a sample CRUD service API with Golang to showcase clean code structure and
    go run cmd/app/main.go
    ```
 
+3. **Build the App**
+   ```bash
+   GOOS=linux GOARCH=amd64 go build -o bin/app ./cmd/app
+   ```
+
+4. **Containerize the App**
+   ```bash
+   docker compose up -d
+   ```
+
 ## 🔧 Future Enhancements
 
 - Add unit tests and integration tests
-- Dockerize the application
 - Add Swagger/OpenAPI documentation
 
 ## 📄 License

api/auth/handler.go

@@ -1,8 +1,6 @@
 package auth
 
 import (
-	"github.com/gofiber/fiber/v2"
-	"github.com/jinzhu/copier"
 	"gorm.io/gorm"
 	"learn-fiber/api/response"
 	"learn-fiber/internal/constant"
@@ -11,6 +9,10 @@ import (
 	"learn-fiber/internal/service"
 	"learn-fiber/internal/util/common"
 	"learn-fiber/internal/util/validator"
+	"net/http"
+
+	"github.com/gofiber/fiber/v2"
+	"github.com/jinzhu/copier"
 )
 
 type Handler struct {
@@ -27,9 +29,9 @@ func (h *Handler) Login(c *fiber.Ctx) error {
 	if hasError, err := validator.V.Valid(req); hasError {
 		return ierror.NewValidationError(err)
 	}
-	result, err := h.svc.Login(req)
+	result, err := h.svc.Login(c.IP(), req)
 	if err != nil {
-		return ierror.NewClientError(200, ierror.ErrCodeAuthenticationError, err.Error())
+		return ierror.NewClientError(http.StatusOK, ierror.ErrCodeAuthenticationError, err.Error())
 	}
 	var res TokenResponse
 	if err = copier.Copy(&res, &result); err != nil {
@@ -43,7 +45,7 @@ func (h *Handler) Logout(c *fiber.Ctx) error {
 	if err != nil {
 		return ierror.NewAuthenticationError(ierror.ErrCodeAuthenticationError, err.Error())
 	}
-	if err := h.svc.Logout(token); err != nil {
+	if err = h.svc.Logout(token); err != nil {
 		return ierror.NewServerError(ierror.ErrCodeTokenError, err.Error())
 	}
 	return response.SendSuccessResponse(c, constant.Success)
@@ -54,22 +56,21 @@ func (h *Handler) RenewToken(c *fiber.Ctx) error {
 	if hasError, err := validator.V.Valid(req); hasError {
 		return ierror.NewValidationError(err)
 	}
-	result, err := h.svc.RenewToken(req)
+	result, err := h.svc.RenewToken(c.IP(), req)
 	if err != nil {
-		return ierror.NewClientError(200, ierror.ErrCodeAuthenticationError, err.Error())
+		return ierror.NewClientError(http.StatusOK, ierror.ErrCodeDataNotFound, err.Error())
 	}
 	var res TokenResponse
 	if err = copier.Copy(&res, &result); err != nil {
 		return ierror.NewServerError(ierror.ErrCodeDtoError, err.Error())
 	}
 	return response.SendSuccessResponse(c, res)
-
 }
 
 func (h *Handler) Info(c *fiber.Ctx) error {
 	result, err := h.svc.Info(common.GetUser(c))
 	if err != nil {
-		return ierror.NewClientError(200, ierror.ErrCodeAuthenticationError, err.Error())
+		return ierror.NewClientError(http.StatusOK, ierror.ErrCodeAuthenticationError, err.Error())
 	}
 	var res UserResponse
 	if err = copier.Copy(&res, &result); err != nil {
@@ -84,7 +85,7 @@ func (h *Handler) ChangePassword(c *fiber.Ctx) error {
 		return ierror.NewValidationError(err)
 	}
 	if err := h.svc.ChangePassword(common.GetUser(c), req); err != nil {
-		return ierror.NewClientError(200, ierror.ErrCodeValidationError, err.Error())
+		return ierror.NewClientError(http.StatusOK, ierror.ErrCodeValidationError, err.Error())
 	}
 	return response.SendSuccessResponse(c, constant.Success)
 }

api/auth/response.go

@@ -9,5 +9,6 @@ type TokenResponse struct {
 type UserResponse struct {
 	Id       uint   `json:"id"`
 	Username string `json:"username"`
+	Email    string `json:"email"`
 	Role     string `json:"role"`
 }

api/department/handler.go

@@ -9,6 +9,7 @@ import (
 	"learn-fiber/internal/service"
 	"learn-fiber/internal/util/common"
 	"learn-fiber/internal/util/validator"
+	"net/http"
 
 	"github.com/gofiber/fiber/v2"
 	"github.com/jinzhu/copier"
@@ -80,7 +81,7 @@ func (h *Handler) Update(c *fiber.Ctx) error {
 	result, err := h.svc.UpdateDepartment(req)
 	if err != nil {
 		if errors.Is(err, gorm.ErrRecordNotFound) {
-			return ierror.NewClientError(200, ierror.ErrCodeDataNotFound, err.Error())
+			return ierror.NewClientError(http.StatusOK, ierror.ErrCodeDataNotFound, err.Error())
 		}
 		return ierror.NewServerError(ierror.ErrCodeDatabaseError, err.Error())
 	}

api/response/error.go

@@ -8,7 +8,7 @@ type ErrorObject struct {
 	Code             string            `json:"code"`
 	Message          string            `json:"message"`
 	ValidationErrors []ValidationError `json:"validationErrors,omitempty"`
-	TraceID          string            `json:"traceID"`
+	TraceID          string            `json:"traceID,omitempty"`
 }
 
 type ValidationError struct {

api/student/handler.go

@@ -9,6 +9,7 @@ import (
 	"learn-fiber/internal/service"
 	"learn-fiber/internal/util/common"
 	"learn-fiber/internal/util/validator"
+	"net/http"
 
 	"github.com/gofiber/fiber/v2"
 	"github.com/jinzhu/copier"
@@ -45,7 +46,7 @@ func (h *Handler) GetById(c *fiber.Ctx) error {
 	result, err := h.svc.GetStudent(id)
 	if err != nil {
 		if errors.Is(err, gorm.ErrRecordNotFound) {
-			return ierror.NewClientError(200, ierror.ErrCodeDataNotFound, err.Error())
+			return ierror.NewClientError(http.StatusOK, ierror.ErrCodeDataNotFound, err.Error())
 		}
 		return ierror.NewServerError(ierror.ErrCodeDatabaseError, err.Error())
 	}
@@ -80,7 +81,7 @@ func (h *Handler) Update(c *fiber.Ctx) error {
 	result, err := h.svc.UpdateStudent(req)
 	if err != nil {
 		if errors.Is(err, gorm.ErrRecordNotFound) {
-			return ierror.NewClientError(200, ierror.ErrCodeDataNotFound, err.Error())
+			return ierror.NewClientError(http.StatusOK, ierror.ErrCodeDataNotFound, err.Error())
 		}
 		return ierror.NewServerError(ierror.ErrCodeDatabaseError, err.Error())
 	}

config/config.go

@@ -13,7 +13,9 @@ type (
 	Config struct {
 		Host             string `mapstructure:"host"`
 		Port             string `mapstructure:"port"`
+		RateLimit        int    `mapstructure:"rate_limit"`
 		IdleTimeout      int    `mapstructure:"idle_timeout"`
+		FailedAttempts   int    `mapstructure:"failed_attempts"`
 		EnablePrintRoute bool   `mapstructure:"enable_print_route"`
 
 		App      `mapstructure:",squash"`
@@ -92,7 +94,9 @@ func Init() error {
 	// 3. replace match any of the existing env vars used in flags
 	pflag.String("host", "", "server host")
 	pflag.Int("port", 8000, "server port")
+	pflag.Int("rate_limit", 100, "rate limit")
 	pflag.Int("idle_timeout", 5, "server idle timeout")
+	pflag.Int("failed_attempts", 5, "login failed attempts")
 	pflag.Bool("enable_print_route", true, "server enable print route")
 
 	pflag.String("app_env", "local", "app env")
@@ -110,7 +114,7 @@ func Init() error {
 	pflag.Bool("db_auto_migrate", false, "database auto migrate")
 
 	pflag.String("redis_addr", "", "redis address")
-	pflag.String("redis_port", "15951", "redis port")
+	pflag.String("redis_port", "6379", "redis port")
 	pflag.String("redis_pwd", "", "redis password")
 
 	pflag.String("tab_enable_text", "", "tablenames before split")
@@ -127,7 +131,9 @@ func Init() error {
 	Cfg = &Config{
 		Host:             viper.GetString("host"),
 		Port:             viper.GetString("port"),
+		RateLimit:        viper.GetInt("rate_limit"),
 		IdleTimeout:      viper.GetInt("idle_timeout"),
+		FailedAttempts:   viper.GetInt("failed_attempts"),
 		EnablePrintRoute: viper.GetBool("enable_print_route"),
 		App: App{
 			Env:     viper.GetString("app_env"),

docker-compose.yaml

@@ -0,0 +1,34 @@
+version: '3.8'
+
+services:
+  tidb:
+    image: pingcap/tidb:latest
+    ports:
+      - "4000:4000"
+    networks:
+      - sample-net
+  redis:
+    image: redis:alpine
+    ports:
+      - "6379:6379"
+    networks:
+      - sample-net
+  app:
+    container_name: sample-crud
+    image: sample-crud
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - "8000:8000"
+    depends_on:
+      - redis
+      - tidb
+    networks:
+      - sample-net
+    environment:
+      - TZ=Asia/Phnom_Penh
+      - REDIS_ADDR=redis
+      - DB_HOST=tidb
+networks:
+  sample-net: