feat(master): Project initialization - [项目初始化]

This commit is contained in:
刘欢 2024-07-02 21:20:58 +08:00
commit 8fada16bcf
6 changed files with 109 additions and 0 deletions

33
.gitignore vendored Normal file
View File

@ -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

21
LICENSE Normal file
View File

@ -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.

23
README.md Normal file
View File

@ -0,0 +1,23 @@
<div align="center">
<img width="100" src="./assets/logo.png" alt="LOGO" />
</div>
<div align="center">
<a href="https://www.oscs1024.com/project/oscs/LLiuHuan/arco-design-pro-vue?ref=badge_small" alt="OSCS Status"><img src="https://www.oscs1024.com/platform/badge/LLiuHuan/arco-design-pro-vue.svg?size=small"/></a>
<a href="https://github.com/LLiuHuan/arco-design-pro-vue"><img src="https://img.shields.io/circleci/project/github/vuejs/vue/dev.svg?sanitize=true" alt="Build Status"></a>
<a href="https://github.com/LLiuHuan/arco-design-pro-vue/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/vue.svg?sanitize=true" alt="License"></a>
</div>
<div align="center">
<span>English | <a href="./README.zh_CN.md">中文</a></span>
</div>
---
`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.

24
README.zh_CN.md Normal file
View File

@ -0,0 +1,24 @@
<div align="center">
<img width="100" src="./assets/logo.png" alt="LOGO" />
</div>
<div align="center">
<a href="https://www.oscs1024.com/project/oscs/LLiuHuan/arco-design-pro-vue?ref=badge_small" alt="OSCS Status"><img src="https://www.oscs1024.com/platform/badge/LLiuHuan/arco-design-pro-vue.svg?size=small"/></a>
<a href="https://github.com/LLiuHuan/arco-design-pro-vue"><img src="https://img.shields.io/circleci/project/github/vuejs/vue/dev.svg?sanitize=true" alt="Build Status"></a>
<a href="https://github.com/LLiuHuan/arco-design-pro-vue/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/vue.svg?sanitize=true" alt="License"></a>
</div>
<div align="center">
<span><a href="./README.md">English</a> | 中文</span>
</div>
---
`gin-template` 是基于 [Gin](https://github.com/gin-gonic/gin) 进行模块化设计的 API 框架,封装了大部分常用的功能,致力于进行快速的业务研发。
本项目基于 [project-layout](https://github.com/golang-standards/project-layout) 项目结构进行设计。
项目完成后会拆分为三部分,迷你版、基础版、完整版,迷你版只包含基础功能,基础版包含基础功能,完整版包含所有有用没用的功能。
完成后不一定可以进行完整的上线测试,所以该项目仅供参考,如需线上使用,请进行完整的上线测试。

3
go.mod Normal file
View File

@ -0,0 +1,3 @@
module github.com/LLiuHuan/gin-template
go 1.22.0

5
main.go Normal file
View File

@ -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