chore(docs): change readme file

khiem20tc · Sep 19, 2024 · 55ad000 · 55ad000
1 parent be0f2a9
commit 55ad000
Show file tree

Hide file tree

Showing 19 changed files with 54 additions and 48 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# BOTP Gateway
+# Fiber Gateway
 
 ![Golang](https://img.shields.io/badge/language-Golang-blue.svg)
 
-The BOTP Gateway is a GoLang-based project designed to serve as a versatile gateway for various API management
+The Fiber Gateway is a GoLang-based project designed to serve as a versatile gateway for various API management
 
 ## Features
 
@@ -16,15 +16,16 @@ The BOTP Gateway is a GoLang-based project designed to serve as a versatile gate
 
 ### Prerequisites
 
-Before you can run the BOTP Gateway, ensure you have the following prerequisites installed:
+Before you can run the Fiber Gateway, ensure you have the following prerequisites installed:
 
 - [Go](https://golang.org/dl/): Make sure you have Go installed on your system.
 
 ### Installation
 
 1. Clone the repository to your local machine:
+
 ```bash
-git clone [email protected]:B-K-Labs/BOTP-Gateway.git
+git clone [email protected]:khiem20tc/go-fiber-gorm-boilerplate.git
 ```
 
 2. Create a `.env` file and define the necessary environment variables. These variables will be used for configuration. Example:
@@ -34,36 +35,41 @@ DATABASE_URL="localhost:5432"
 ```
 
 3. Download and install packages
+
 ```bash
 go mod download && go mod tidy
 ```
 
-4. Run the BOTP Gateway using the following command:
+4. Run the Fiber Gateway using the following command:
+
 ```bash
 go run main.go
 ```
 
-or 
+or
 
 ```bash
 nodemon --watch './**/*.go' --signal SIGTERM --exec 'go' run ./main.go
 ```
 
 5. Run Lint-stage for Golang
+
 ```bash
-golangci-lint run  
+golangci-lint run
 ```
 
 5. Gen swagger API document using the following command:
+
 ```bash
 go run ./scripts/gen-swagger/main.go && go run ./scripts/swag/main.go init --ot go,json --parseDependency true
 ```
 
 6. Build docker container
+
 ```bash
 docker-compose up -d --force-recreate
 ```
 
 ## Usage
 
-Once the BOTP Gateway is up and running, you can start sending API requests to it, and it will handle load balancing, rate limiting, and forwarding based on the configuration.
+Once the Fiber Gateway is up and running, you can start sending API requests to it, and it will handle load balancing, rate limiting, and forwarding based on the configuration.
diff --git a/dto/user.dto.go b/dto/user.dto.go
@@ -1,7 +1,7 @@
 package dto
 
 import (
-	"botp-gateway/model"
+	"fiber-gateway/model"
 	"time"
 
 	"github.com/dranikpg/dto-mapper"

diff --git a/go.mod b/go.mod
@@ -1,4 +1,4 @@
-module botp-gateway
+module fiber-gateway
 
 go 1.21
 

diff --git a/gorm/gorm.go b/gorm/gorm.go
@@ -4,8 +4,8 @@ import (
 	"fmt"
 	"log"
 
-	config "botp-gateway/config"
-	model "botp-gateway/model"
+	config "fiber-gateway/config"
+	model "fiber-gateway/model"
 
 	"gorm.io/driver/postgres"
 	"gorm.io/gorm"

diff --git a/main.go b/main.go
@@ -1,21 +1,21 @@
 package main
 
 import (
-	"botp-gateway/config"
-	"botp-gateway/router"
+	"fiber-gateway/config"
+	"fiber-gateway/router"
 
 	"github.com/gofiber/fiber/v2"
 	"github.com/gofiber/fiber/v2/middleware/logger"
 	"github.com/gofiber/fiber/v2/middleware/monitor"
 	"github.com/gofiber/swagger"
 )
 
-// @title BOTP Gateway API
+// @title Fiber Gateway API
 // @version 1.0
-// @description Documentation for BOTP Gateway API
+// @description Documentation for Fiber Gateway API
 // @termsOfService http://swagger.io/terms/
 
-// @contact.name BOTP Gateway Support
+// @contact.name Fiber Gateway Support
 // @contact.url http://www.swagger.io/support
 // @contact.email [email protected]
 

diff --git a/middleware/auth.middleware.go b/middleware/auth.middleware.go
@@ -1,8 +1,8 @@
 package middleware
 
 import (
-	"botp-gateway/model"
-	jsonWebToken "botp-gateway/utils/jwt"
+	"fiber-gateway/model"
+	jsonWebToken "fiber-gateway/utils/jwt"
 	"slices"
 
 	"github.com/gofiber/fiber/v2"

diff --git a/middleware/rateLimit/rateLimit.middleware.go b/middleware/rateLimit/rateLimit.middleware.go
@@ -1,7 +1,7 @@
 package rateLimitMiddleware
 
 import (
-	"botp-gateway/validator"
+	"fiber-gateway/validator"
 	"time"
 
 	"github.com/gofiber/fiber/v2"

diff --git a/router/router.go b/router/router.go
@@ -1,11 +1,11 @@
 package router
 
 import (
-	userRouter "botp-gateway/router/user"
+	userRouter "fiber-gateway/router/user"
 
 	"github.com/gofiber/fiber/v2"
 )
 
 func New(app *fiber.App) {
 	userRouter.CreateRouter(app)
-}
+}
diff --git a/router/user/user.router.go b/router/user/user.router.go
@@ -1,7 +1,7 @@
 package userRouter
 
 import (
-	userService "botp-gateway/service/user"
+	userService "fiber-gateway/service/user"
 
 	"github.com/gofiber/fiber/v2"
 )

diff --git a/scripts/gen-swagger/main.go b/scripts/gen-swagger/main.go
@@ -1,13 +1,13 @@
 package main
 
 import (
-	"botp-gateway/scripts/gen-swagger/types"
-	commonUtil "botp-gateway/scripts/gen-swagger/utils/common"
-	convertType "botp-gateway/scripts/gen-swagger/utils/convert-type"
-	deftSourceUtil "botp-gateway/scripts/gen-swagger/utils/deft-source"
-	fileUtil "botp-gateway/scripts/gen-swagger/utils/file"
-	genCommentUtil "botp-gateway/scripts/gen-swagger/utils/gen-comment"
-	sourceDataUtil "botp-gateway/scripts/gen-swagger/utils/source-data"
+	"fiber-gateway/scripts/gen-swagger/types"
+	commonUtil "fiber-gateway/scripts/gen-swagger/utils/common"
+	convertType "fiber-gateway/scripts/gen-swagger/utils/convert-type"
+	deftSourceUtil "fiber-gateway/scripts/gen-swagger/utils/deft-source"
+	fileUtil "fiber-gateway/scripts/gen-swagger/utils/file"
+	genCommentUtil "fiber-gateway/scripts/gen-swagger/utils/gen-comment"
+	sourceDataUtil "fiber-gateway/scripts/gen-swagger/utils/source-data"
 	"fmt"
 	"go/ast"
 	"go/format"

diff --git a/scripts/gen-swagger/types/common.types.go b/scripts/gen-swagger/types/common.types.go
@@ -1,8 +1,8 @@
 package types
 
 import (
-	convertTypeUtil "botp-gateway/scripts/gen-swagger/utils/convert-type"
-	sourceDataUtil "botp-gateway/scripts/gen-swagger/utils/source-data"
+	convertTypeUtil "fiber-gateway/scripts/gen-swagger/utils/convert-type"
+	sourceDataUtil "fiber-gateway/scripts/gen-swagger/utils/source-data"
 	"go/ast"
 )
 

diff --git a/scripts/gen-swagger/utils/convert-type/convert-type.util.go b/scripts/gen-swagger/utils/convert-type/convert-type.util.go
@@ -1,9 +1,9 @@
 package convertTypeUtil
 
 import (
-	commonUtil "botp-gateway/scripts/gen-swagger/utils/common"
-	deftSourceUtil "botp-gateway/scripts/gen-swagger/utils/deft-source"
-	sourceDataUtil "botp-gateway/scripts/gen-swagger/utils/source-data"
+	commonUtil "fiber-gateway/scripts/gen-swagger/utils/common"
+	deftSourceUtil "fiber-gateway/scripts/gen-swagger/utils/deft-source"
+	sourceDataUtil "fiber-gateway/scripts/gen-swagger/utils/source-data"
 	"fmt"
 	"go/ast"
 	"reflect"

diff --git a/scripts/gen-swagger/utils/file/file.util.go b/scripts/gen-swagger/utils/file/file.util.go
@@ -1,7 +1,7 @@
 package fileUtil
 
 import (
-	"botp-gateway/scripts/gen-swagger/types"
+	"fiber-gateway/scripts/gen-swagger/types"
 	"fmt"
 	"go/ast"
 	"go/parser"

diff --git a/scripts/gen-swagger/utils/gen-comment/gen-comment.util.go b/scripts/gen-swagger/utils/gen-comment/gen-comment.util.go
@@ -1,10 +1,10 @@
 package genCommentUtil
 
 import (
-	"botp-gateway/scripts/gen-swagger/types"
-	commonUtil "botp-gateway/scripts/gen-swagger/utils/common"
-	convertTypeUtil "botp-gateway/scripts/gen-swagger/utils/convert-type"
-	sourceDataUtil "botp-gateway/scripts/gen-swagger/utils/source-data"
+	"fiber-gateway/scripts/gen-swagger/types"
+	commonUtil "fiber-gateway/scripts/gen-swagger/utils/common"
+	convertTypeUtil "fiber-gateway/scripts/gen-swagger/utils/convert-type"
+	sourceDataUtil "fiber-gateway/scripts/gen-swagger/utils/source-data"
 	"fmt"
 	"sort"
 

diff --git a/service/user/user.service.go b/service/user/user.service.go
@@ -1,8 +1,8 @@
 package userService
 
 import (
-	"botp-gateway/gorm"
-	"botp-gateway/model"
+	"fiber-gateway/gorm"
+	"fiber-gateway/model"
 
 	"github.com/gofiber/fiber/v2"
 )

diff --git a/utils/aes/aes.go b/utils/aes/aes.go
@@ -1,14 +1,14 @@
 package aes
 
 import (
-	"botp-gateway/config"
 	"bytes"
 	"crypto/aes"
 	"crypto/cipher"
 	"crypto/rand"
 	"crypto/sha256"
 	"encoding/base64"
 	"errors"
+	"fiber-gateway/config"
 	"io"
 )
 

diff --git a/utils/jwt/jwt.go b/utils/jwt/jwt.go
@@ -1,13 +1,13 @@
 package jsonWebToken
 
 import (
-	"botp-gateway/config"
-	"botp-gateway/model"
+	"fiber-gateway/config"
+	"fiber-gateway/model"
 	"time"
 
 	jwt "github.com/golang-jwt/jwt/v5"
 
-	redis "botp-gateway/utils/redis"
+	redis "fiber-gateway/utils/redis"
 )
 
 var timeExpiredTokenEmail = time.Minute * 15

diff --git a/utils/totp/totp.go b/utils/totp/totp.go
@@ -1,8 +1,8 @@
 package totp
 
 import (
-	"botp-gateway/config"
 	"encoding/base32"
+	"fiber-gateway/config"
 	"log"
 	"time"
 

diff --git a/validator/register-custom-validator.go b/validator/register-custom-validator.go
@@ -1,7 +1,7 @@
 package validator
 
 import (
-	"botp-gateway/middleware"
+	"fiber-gateway/middleware"
 	"reflect"
 	"regexp"
 	"strings"