v1 base

Author: mmqnym

.gitignore

@@ -0,0 +1,20 @@
+Copyright (c) 2024 0xmmq
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Dockerfile

@@ -0,0 +1,25 @@
+<h1 align="center">GoInk</h1>
+<p align="center">
+    <img src="./assets/goink.png" height="300px"></img>
+</p>
+<p align="center">
+    <img alt="app version" src="https://img.shields.io/github/v/release/mmqnym/GoInk"></img>
+    <a href="https://goreportcard.com/report/github.com/mmqnym/GoInk"><img src="https://goreportcard.com/badge/github.com/mmqnym/GoInk"></a>
+    <img alt="license" src="https://img.shields.io/github/license/mmqnym/GoInk"></img>
+</p>
+
+## Introduction
+
+This project is based on the following open source libraries:
+
+- [Gin](https://github.com/gin-gonic/gin)
+- [swaggo](https://github.com/swaggo/swag)
+- [zap](https://github.com/uber-go/zap)
+- [lumberjack](https://github.com/natefinch/lumberjack)
+- [golang-jwt](https://github.com/golang-jwt/jwt)
+
+It' s used to quickly build a web server with mainstream infrastructure to provide an environment for quickly developing API routes, middleware, and database operations, and to save the time of file hierarchy planning and log customization.
+
+## License
+
+[MIT](./LICENSE.md)

LICENSE.md

@@ -0,0 +1,5 @@
+package cache
+
+/*
+	Discription: You can write down the control codes associated with the cache here.
+*/

README.md

@@ -0,0 +1,151 @@
+package config
+
+/*
+	Discription: You can add your own config here.
+*/
+
+import (
+	"errors"
+	"os"
+	"path/filepath"
+
+	"gopkg.in/yaml.v3"
+)
+
+type serverConfig struct {
+	Mode  string `yaml:"mode"`
+	Port  string `yaml:"port"`
+	Http2 bool   `yaml:"http2"`
+}
+
+type logConfig struct {
+	Level  string `yaml:"level"`
+	Output struct {
+		Stdout bool `yaml:"stdout"`
+		File   bool `yaml:"file"`
+	} `yaml:"output"`
+	FileName  string `yaml:"fileName"`
+	MaxSize   int    `yaml:"maxSize"`
+	MaxAge    int    `yaml:"maxAge"`
+	LocalTime bool   `yaml:"localTime"`
+	Compress  bool   `yaml:"compress"`
+}
+
+type databaseConfig struct {
+	Name     string `yaml:"name"`
+	Host     string `yaml:"host"`
+	Port     int    `yaml:"port"`
+	User     string `yaml:"user"`
+	Password string `yaml:"password"`
+}
+
+type middlewareConfig struct {
+	Cors struct {
+		Enabled          bool     `yaml:"enabled"`
+		AllowOrigins     []string `yaml:"allowOrigins"`
+		AllowMethods     string   `yaml:"allowMethods"`
+		AllowHeaders     string   `yaml:"allowHeaders"`
+		ExposeHeaders    string   `yaml:"exposeHeaders"`
+		MaxAge           string   `yaml:"maxAge"`
+		AllowCredentials string   `yaml:"allowCredentials"`
+	} `yaml:"cors"`
+
+	Auth struct {
+		JwtSecret        string `yaml:"jwtSecret"`
+		JwtSigningMethod string `yaml:"jwtSigningMethod"`
+		JwtExpires       int64  `yaml:"jwtExpires"`
+		XAuthToken       string `yaml:"xAuthToken"`
+	} `yaml:"auth"`
+}
+
+type gatewayConfig struct {
+	Example struct {
+		Url    string `yaml:"url"`
+		ApiKey string `yaml:"apiKey"`
+	} `yaml:"example"`
+}
+
+var rootPath string
+
+var Server serverConfig
+var Log logConfig
+var Database databaseConfig
+var Middleware middlewareConfig
+var Gateway gatewayConfig
+
+func init() {
+	setProjectRoot()
+
+	loadConfig("server.yml", &Server)
+	loadConfig("log.yml", &Log)
+	loadConfig("database.yml", &Database)
+	loadConfig("middleware.yml", &Middleware)
+	loadConfig("gateway.yml", &Gateway)
+	// add more config here
+
+	validateConfig()
+}
+
+func loadConfig(fileName string, target interface{}) {
+	file, err := os.ReadFile(rootPath + "/config/" + fileName)
+	checkError(err)
+
+	err = yaml.Unmarshal(file, target)
+	checkError(err)
+}
+
+// setProjectRoot() will finds the root of this project and sets it to rootPath
+func setProjectRoot() {
+	currentDir, err := os.Getwd()
+	if err != nil {
+		panic(err)
+	}
+
+	for {
+		gomod := filepath.Join(currentDir, "go.mod")
+		if _, err := os.Stat(gomod); err == nil {
+			rootPath = currentDir
+			break
+		}
+
+		nextDir := filepath.Dir(currentDir)
+		if nextDir == currentDir {
+			panic(errors.New("RootNotFoundError"))
+		}
+
+		currentDir = nextDir
+	}
+}
+
+func validateConfig() {
+	validateServerConfig()
+	validateLogConfig()
+
+	// add more validation here
+}
+
+func validateServerConfig() {
+	if Server.Mode != "dev" && Server.Mode != "release" {
+		panic(errors.New("InvalidModeError"))
+	}
+
+	if Server.Port == "" || Server.Port[0] != ':' || len(Server.Port) < 2 {
+		panic(errors.New("InvalidPortError"))
+	}
+}
+
+func validateLogConfig() {
+	if Log.Level != "debug" &&
+		Log.Level != "info" &&
+		Log.Level != "warn" &&
+		Log.Level != "error" &&
+		Log.Level != "fatal" {
+		panic(errors.New("InvalidLevelError"))
+	}
+}
+
+func checkError(err error) {
+	if err != nil {
+		panic(err)
+	}
+}

assets/goink.png

@@ -0,0 +1,5 @@
+name: "psql"
+host: "psql"
+port: 5432
+user: "root"
+password: "password"

cache/cache.go

@@ -0,0 +1 @@
+example: { url: "https://example.com", apiKey: "EXAMPLE_API_KEY" }

config/config.go

@@ -0,0 +1,9 @@
+level: "info"
+output:
+  stdout: true
+  file: true
+fileName: "TEMP.log"
+maxSize: 10
+maxAge: 5
+localTime: true
+compress: true