Let's go

Author: virakthaka

.env.example

@@ -0,0 +1,22 @@
+PORT=8000
+IDLE_TIMEOUT=5
+ENABLE_PRINT_ROUTE=true
+
+APP_ENV=local
+APP_NAME=example api
+APP_VERSION=0.0.1
+
+LOG_LEVEL=debug
+
+DB_HOST=localhost
+DB_PORT=4000
+DB_USER=root
+DB_PASSWORD=
+DB_NAME=test
+DB_USE_SSL=false
+DB_AUTO_MIGRATE=true
+
+REDIS_ADDR=localhost
+REDIS_PORT=6379
+
+JWT_SECRET=c62028e29ccec50c690c3579ea5f87b4f5cfa92bd4cf039ae0b05975b8cbc1b4

.gitignore

@@ -0,0 +1,49 @@
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build outputs
+*.test
+*.out
+
+# Output of the go coverage tool
+*.coverprofile
+
+# Go workspace file
+go.work
+go.work.sum
+
+# Logs and debug
+*.log
+
+# Dependency directories (vendor/)
+vendor/
+
+# IDEs and editors
+.vscode/
+.idea/
+*.swp
+
+# OS generated files
+.DS_Store
+Thumbs.db
+
+# Environment variable files
+.env
+.env.local
+.env.*.local
+
+# Redis dump file (if used locally)
+dump.rdb
+
+# Database files (if TiDB or SQLite dumps exist)
+*.db
+*.sql
+
+# Cache and build directories
+bin/
+build/
+dist/

README.md

@@ -0,0 +1,72 @@
+# 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 and **Redis** for caching and other in-memory operations.
+
+## 🚀 Project Purpose
+
+Build a sample CRUD service API with Golang to showcase clean 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
+
+## 📁 Project Structure
+
+```
+├── cmd/
+│   └── app/
+│       └── main.go                # Application entry point
+├── pkg/                           # Shared package configure
+│   └── bcrypt/
+|       └── bcrypt.go              # Bcrypt hashing                 
+│   └── redis/                     
+|       └── redis.go               # Redis configuration
+│   └── db/                        
+|       └── db.go                  # DB configuration
+├── api/
+│   └── student/
+│       ├── route.go               # Student-related endpoints
+│       └── handler.go             # Logic for handling student API requests
+├── internal/
+│   ├── service/                   # Business logic, called from handler
+│   ├── repository/                # Data access layer (calls GORM & queries DB)
+│   ├── model/                     # Database models/entities
+│   └── dto/                       # DTOs for transforming request/response data
+```
+
+## 📌 Key Concepts
+
+- **Layered Architecture**: Divides the project into clear layers for maintainability and scalability.
+- **DTO Pattern**: Uses `copier` to map between internal models and response/request 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.
+
+## 🧪 Running the Project
+
+1. **Configure Environment**
+   Create a `.env` file. find in a `.env.example` file for environment:
+   - JWT Secret key
+   - TiDB connection
+   - Redis connection
+
+2. **Run the App**
+   ```bash
+   go run cmd/app/main.go
+   ```
+
+## 🔧 Future Enhancements
+
+- Add unit tests and integration tests
+- Implement authentication and authorization
+- Dockerize the application
+- Add Swagger/OpenAPI documentation
+
+## 📄 License
+
+This project is open-source and available under the [MIT License](LICENSE).

api/auth/handler.go

@@ -0,0 +1,40 @@
+package auth
+
+import (
+	"learn-fiber/api/response"
+	"learn-fiber/config"
+	"learn-fiber/internal/util/common"
+	"time"
+
+	"github.com/gofiber/fiber/v2"
+	"github.com/golang-jwt/jwt/v5"
+	"gorm.io/gorm"
+)
+
+type Handler struct {
+	db *gorm.DB
+}
+
+func NewHandler(db *gorm.DB) *Handler {
+	return &Handler{db: db}
+}
+
+func (h *Handler) Login(c *fiber.Ctx) error {
+	req, err := common.GetRequestBody[Request](c)
+	if err != nil {
+		return err
+	}
+
+	token := jwt.NewWithClaims(jwt.SigningMethodHS256, jwt.MapClaims{
+		"username": req.Username,
+		"role":     "admin",
+		"exp":      time.Now().Add(time.Hour * 1).Unix(),
+	})
+
+	secret := []byte(config.Cfg.JWT.Secret)
+	res, err := token.SignedString(secret)
+	if err != nil {
+		return c.Status(500).JSON(fiber.Map{"error": "Could not generate token"})
+	}
+	return response.SendSuccessResponse(c, res)
+}

api/auth/request.go

@@ -0,0 +1,6 @@
+package auth
+
+type Request struct {
+	Username string `json:"username" validate:"required"`
+	Password string `json:"password" validate:"required"`
+}

api/auth/routes.go

@@ -0,0 +1,12 @@
+package auth
+
+import (
+	"github.com/gofiber/fiber/v2"
+	"gorm.io/gorm"
+)
+
+func AddRoutes(r fiber.Router, db *gorm.DB) {
+	handler := NewHandler(db)
+	router := r.Group("/auth")
+	router.Post("login", handler.Login)
+}

api/department/handler.go

@@ -0,0 +1,82 @@
+package department
+
+import (
+	"learn-fiber/api/response"
+	"learn-fiber/internal/dto"
+	"learn-fiber/internal/ierror"
+	"learn-fiber/internal/service"
+	"learn-fiber/internal/util/common"
+	"learn-fiber/internal/util/validator"
+
+	"github.com/gofiber/fiber/v2"
+	"github.com/jinzhu/copier"
+	"gorm.io/gorm"
+)
+
+type Handler struct {
+	service service.Department
+}
+
+func NewHandler(db *gorm.DB) *Handler {
+	svc := service.NewDepartment(db)
+	return &Handler{service: svc}
+}
+
+func (h *Handler) GetList(c *fiber.Ctx) error {
+	query, _ := common.GetQueryParam[dto.QueryParams](c)
+	if hasError, err := validator.V.Valid(query); hasError {
+		return ierror.NewValidationError(err)
+	}
+	result, page, err := h.service.GetAllDepartment(query)
+	if err != nil {
+		return response.SendFailResponse(c, err.Error())
+	}
+	var res []Response
+	_ = copier.Copy(&res, &result)
+	return response.SendSuccessResponsePaging(c, res, page)
+}
+
+func (h *Handler) GetById(c *fiber.Ctx) error {
+	id := c.Params("id")
+	result, err := h.service.GetDepartment(id)
+	if err != nil {
+		return response.SendFailResponse(c, err.Error())
+	}
+	var res Response
+	_ = copier.Copy(&res, &result)
+	return response.SendSuccessResponse(c, res)
+}
+
+func (h *Handler) Create(c *fiber.Ctx) error {
+	req, _ := common.GetRequestBody[dto.DepartmentCreateRequest](c)
+	if hasError, err := validator.V.Valid(req); hasError {
+		return ierror.NewValidationError(err)
+	}
+	result, err := h.service.CreateDepartment(req)
+	if err != nil {
+		return response.SendFailResponse(c, err.Error())
+	}
+	var res Response
+	_ = copier.Copy(&res, &result)
+	return response.SendSuccessResponse(c, res)
+}
+
+func (h *Handler) Update(c *fiber.Ctx) error {
+	req, _ := common.GetRequestBody[dto.DepartmentUpdateRequest](c)
+	if hasError, err := validator.V.Valid(req); hasError {
+		return ierror.NewValidationError(err)
+	}
+	result, err := h.service.UpdateDepartment(req)
+	if err != nil {
+		return response.SendFailResponse(c, err.Error())
+	}
+	var res Response
+	_ = copier.Copy(&res, &result)
+	return response.SendSuccessResponse(c, res)
+}
+
+func (h *Handler) Delete(c *fiber.Ctx) error {
+	id := c.Params("id")
+	_ = h.service.DeleteDepartment(id)
+	return response.SendSuccessResponse(c, nil)
+}

api/department/response.go

@@ -0,0 +1,8 @@
+package department
+
+type Response struct {
+	Id           string `json:"id"`
+	Code         string `json:"code"`
+	DepartmentEN string `json:"departmentEN"`
+	DepartmentKM string `json:"departmentKM"`
+}

api/department/routes.go

@@ -0,0 +1,21 @@
+package department
+
+import (
+	"learn-fiber/internal/middleware"
+
+	"github.com/gofiber/fiber/v2"
+	"gorm.io/gorm"
+)
+
+func AddRoutes(r fiber.Router, db *gorm.DB) {
+	handler := NewHandler(db)
+	router := r.Group("/department",
+		middleware.JWTProtected(),
+		middleware.RequireRole("admin"),
+	)
+	router.Put("", handler.Update)
+	router.Get("", handler.GetList)
+	router.Post("", handler.Create)
+	router.Get(":id", handler.GetById)
+	router.Delete(":id", handler.Delete)
+}

api/response/error.go

@@ -0,0 +1,17 @@
+package response
+
+type ErrorResponse struct {
+	Error ErrorObject `json:"error"`
+}
+
+type ErrorObject struct {
+	Code             string            `json:"code"`
+	Message          string            `json:"message"`
+	ValidationErrors []ValidationError `json:"validationErrors,omitempty"`
+	TraceID          string            `json:"traceID"`
+}
+
+type ValidationError struct {
+	Field   string `json:"field"`
+	Message string `json:"message"`
+}