potato/README.md

Potato

Go项目脚手架

基于gin、gorm、zap的脚手架

本脚手架包含以下内容：

1. mvc结构。
2. swagger接口文档。
3. 配置、数据库、redis、日志、工具库封装。
4. 单点登陆(jwt)。

内容列表

• Potato
  • 内容列表
  • 项目结构
  • 安装
  • 使用说明
  • 相关仓库
  • 如何贡献
  • 使用许可

项目结构

potato ├── config(配置目录) ├── docs(文档集合) ├── global(全局变量) ├── initialize(初始化函数) ├── internal(内部模块) │   ├── controller(控制器层，用于存放控制器) │   ├── dao(数据访问层，所有与数据相关等操作都会在dao层进行) │   ├── middleware(HTTP中间件) │   ├── model(模型层，用于存放model对象) │   ├── routers(路由相关逻辑处理) │   └── service(项目核心业务逻辑) ├── pkg(项目相关等模块包) ├── scripts(各类构建、按照，分析等操作等脚本) └── tmp(项目生成的临时文件)

安装

这个项目使用 go 和 swag。请确保你本地安装了它们。

$ tar -C /usr/local -xzf go1.4.linux-amd64.tar.gz
$ export PATH=$PATH:/usr/local/go/bin

使用说明

$ go build -o potato main.go
$ ./potato

相关仓库

• Gin — Web Framework
• Gorm — ORM
• Swag - RESTful API Doc

如何贡献

非常欢迎你的加入！提一个 Issue 或者提交一个 Pull Request。

使用许可

MIT © Viletyy