From 8fada16bcf8c17e98702b047ad80dd1aa0c69eea Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=88=98=E6=AC=A2?= <184555556@qq.com> Date: Tue, 2 Jul 2024 21:20:58 +0800 Subject: [PATCH] =?UTF-8?q?feat(master):=20Project=20initialization=20-=20?= =?UTF-8?q?[=E9=A1=B9=E7=9B=AE=E5=88=9D=E5=A7=8B=E5=8C=96]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 33 +++++++++++++++++++++++++++++++++ LICENSE | 21 +++++++++++++++++++++ README.md | 23 +++++++++++++++++++++++ README.zh_CN.md | 24 ++++++++++++++++++++++++ go.mod | 3 +++ main.go | 5 +++++ 6 files changed, 109 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 README.zh_CN.md create mode 100644 go.mod create mode 100644 main.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0d2e705 --- /dev/null +++ b/.gitignore @@ -0,0 +1,33 @@ +# If you prefer the allow list template instead of the deny list, see community template: +# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore +# +# Binaries for programs and plugins +*.exe +*.exe~ +*.dll +*.so +*.dylib + +# Test binary, built with `go test -c` +*.test + +# Output of the go coverage tool, specifically when used with LiteIDE +*.out + +# Dependency directories (remove the comment below to include it) +# vendor/ + +# Go workspace file +go.work + +.idea/ +.DS_Store + +tmp/* + +# Project runtime log +logs/*.log + +docs + +INSTALL.lock \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2b4b869 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 刘欢 + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4902e8c --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +
+ LOGO +
+ +
+ + Build Status + License +
+ +
+ English | 中文 +
+ +--- + +`gin-template` is an API framework with modular design based on [Gin](https://github.com/gin-gonic/gin). It encapsulates most commonly used functions and is dedicated to rapid business research and development. + +This project is designed based on the [project-layout](https://github.com/golang-standards/project-layout) project structure. + +After the project is completed, it will be divided into three parts: mini version, basic version, and full version. The mini version only contains basic functions, the basic version includes basic functions, and the full version includes all useful and useless functions. + +It may not be possible to conduct a complete online test after completion, so this project is for reference only. If you need to use it online, please conduct a complete online test. diff --git a/README.zh_CN.md b/README.zh_CN.md new file mode 100644 index 0000000..6591738 --- /dev/null +++ b/README.zh_CN.md @@ -0,0 +1,24 @@ +
+ LOGO +
+ +
+ + Build Status + License +
+ +
+ English | 中文 +
+ +--- + +`gin-template` 是基于 [Gin](https://github.com/gin-gonic/gin) 进行模块化设计的 API 框架,封装了大部分常用的功能,致力于进行快速的业务研发。 + +本项目基于 [project-layout](https://github.com/golang-standards/project-layout) 项目结构进行设计。 + +项目完成后会拆分为三部分,迷你版、基础版、完整版,迷你版只包含基础功能,基础版包含基础功能,完整版包含所有有用没用的功能。 + +完成后不一定可以进行完整的上线测试,所以该项目仅供参考,如需线上使用,请进行完整的上线测试。 + diff --git a/go.mod b/go.mod new file mode 100644 index 0000000..d65a331 --- /dev/null +++ b/go.mod @@ -0,0 +1,3 @@ +module github.com/LLiuHuan/gin-template + +go 1.22.0 diff --git a/main.go b/main.go new file mode 100644 index 0000000..db1ebd4 --- /dev/null +++ b/main.go @@ -0,0 +1,5 @@ +// Package gin_template +// @program: gin-template +// @author: [lliuhuan](https://github.com/lliuhuan) +// @create: 2024-07-02 18:07 +package gin_template