2021-04-06 10:35:28 +08:00
|
|
|
|
<!--
|
|
|
|
|
|
* @Date: 2021-03-21 19:54:57
|
|
|
|
|
|
* @LastEditors: viletyy
|
2021-06-10 15:37:36 +08:00
|
|
|
|
* @LastEditTime: 2021-06-10 15:14:37
|
2021-04-06 10:35:28 +08:00
|
|
|
|
* @FilePath: /potato/README.md
|
|
|
|
|
|
-->
|
|
|
|
|
|
# Potato
|
|
|
|
|
|
|
|
|
|
|
|
[](https://github.com/viletyy/potato)
|
|
|
|
|
|
|
|
|
|
|
|
Go项目脚手架
|
|
|
|
|
|
|
|
|
|
|
|
基于gin、gorm、zap的脚手架
|
|
|
|
|
|
|
|
|
|
|
|
本脚手架包含以下内容：
|
|
|
|
|
|
|
|
|
|
|
|
1. mvc结构。
|
|
|
|
|
|
2. swagger接口文档。
|
|
|
|
|
|
3. 配置、数据库、redis、日志、工具库封装。
|
|
|
|
|
|
4. 单点登陆(jwt)。
|
|
|
|
|
|
|
|
|
|
|
|
## 内容列表
|
|
|
|
|
|
|
2021-06-10 15:37:36 +08:00
|
|
|
|
- [Potato](#potato)
|
|
|
|
|
|
- [内容列表](#内容列表)
|
|
|
|
|
|
- [项目结构](#项目结构)
|
|
|
|
|
|
- [安装](#安装)
|
|
|
|
|
|
- [使用说明](#使用说明)
|
|
|
|
|
|
- [相关仓库](#相关仓库)
|
|
|
|
|
|
- [如何贡献](#如何贡献)
|
|
|
|
|
|
- [使用许可](#使用许可)
|
|
|
|
|
|
|
|
|
|
|
|
## 项目结构
|
|
|
|
|
|
potato
|
|
|
|
|
|
├── config(配置目录)
|
|
|
|
|
|
├── docs(文档集合)
|
|
|
|
|
|
├── global(全局变量)
|
|
|
|
|
|
├── initialize(初始化函数)
|
|
|
|
|
|
├── internal(内部模块)
|
|
|
|
|
|
│ ├── controller(控制器层，用于存放控制器)
|
|
|
|
|
|
│ ├── dao(数据访问层，所有与数据相关等操作都会在dao层进行)
|
|
|
|
|
|
│ ├── middleware(HTTP中间件)
|
|
|
|
|
|
│ ├── model(模型层，用于存放model对象)
|
|
|
|
|
|
│ ├── routers(路由相关逻辑处理)
|
|
|
|
|
|
│ └── service(项目核心业务逻辑)
|
|
|
|
|
|
├── pkg(项目相关等模块包)
|
|
|
|
|
|
├── scripts(各类构建、按照，分析等操作等脚本)
|
|
|
|
|
|
└── tmp(项目生成的临时文件)
|
|
|
|
|
|
|
2021-04-06 10:35:28 +08:00
|
|
|
|
|
|
|
|
|
|
## 安装
|
|
|
|
|
|
|
|
|
|
|
|
这个项目使用 [go](https://golang.org/) 和 [swag](https://github.com/swaggo/swag)。请确保你本地安装了它们。
|
|
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
|
$ tar -C /usr/local -xzf go1.4.linux-amd64.tar.gz
|
|
|
|
|
|
$ export PATH=$PATH:/usr/local/go/bin
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 使用说明
|
|
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
|
$ go build -o potato main.go
|
|
|
|
|
|
$ ./potato
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
## 相关仓库
|
|
|
|
|
|
|
|
|
|
|
|
- [Gin](https://github.com/gin-gonic/gin) — Web Framework
|
|
|
|
|
|
- [Gorm](https://github.com/jinzhu/gorm) — ORM
|
2021-06-10 15:37:36 +08:00
|
|
|
|
- [Swag](https://github.com/swaggo/swag) - RESTful API Doc
|
2021-04-06 10:35:28 +08:00
|
|
|
|
|
|
|
|
|
|
## 如何贡献
|
|
|
|
|
|
|
|
|
|
|
|
非常欢迎你的加入！[提一个 Issue](https://github.com/viletyy/potato/issues/new) 或者提交一个 Pull Request。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 使用许可
|
|
|
|
|
|
|
|
|
|
|
|
[MIT](LICENSE) © Viletyy
|
