全栈后台管理系统脚手架 gin-vue-admin 2.0版本介绍

项目文档

1. 基本介绍

1.1 项目介绍

Gin-vue-admin是一个基于vue和gin开发的全栈前后端分离的后台管理系统，集成jwt鉴权，动态路由，动态菜单，casbin鉴权，表单生成器，代码生成器等功能，提供多种示例文件，让您把更多时间专注在业务开发上。

1.2 贡献指南

Hi! 首先感谢你使用 gin-vue-admin。

Gin-vue-admin 是一套为后台管理平台准备的一整套前后端分离架构式的开源框架，旨在快速搭建后台管理系统。

Gin-vue-admin 的成长离不开大家的支持，如果你愿意为 gin-vue-admin 贡献代码或提供建议，请阅读以下内容。

1.2.1 Issue 规范

  • issue 仅用于提交 Bug 或 Feature 以及设计相关的内容，其它内容可能会被直接关闭。如果你在使用时产生了疑问，请到 Slack 或 Gitter 里咨询。
  • 在提交 issue 之前，请搜索相关内容是否已被提出。

1.2.2 Pull Request 规范

[文件名]: 描述信息README.md: fix xxx bugdevelopmaster

1.3 版本列表

  • master: 2.0 dev code, for prod
  • develop: 2.0 dev code, for test
  • gin-vue-admin_v2.0_dev （v2.0 不再兼容 v1.0）
  • gin-vue-admin_v1.0_stable （v1.0 稳定版，会持续更新和维护）
  • gin-vue-admin_v1.0_dev （v1.0 稳定版，会持续更新和维护）

2. 使用说明

- node版本 > v8.6.0
- golang版本 >= v1.11
- IDE推荐：Golang
- 各位在clone项目以后，把db文件导入自己创建的库后，最好前往七牛云申请自己的空间地址。
- 替换掉项目中的七牛云公钥，私钥，仓名和默认url地址，以免发生测试文件数据错乱

2.1 web端

# clone the project
git clone https://github.com/piexlmax/gin-vue-admin.git

# enter the project directory
cd web

# install dependency
npm install

# develop
npm run serve

2.2 server端

# 使用 go.mod

# 安装 go 依赖包
go list (go mod tidy)

# 编译
go build

2.3 生成swagger自动化API文档

2.3.1 安装 swagger

（1）可以翻墙

go get -u github.com/swaggo/swag/cmd/swag

（2）无法翻墙

gopm
# 下载gopm包
go get -v -u github.com/gpmgo/gopm

# 执行
gopm get -g -v github.com/swaggo/swag/cmd/swag

# 到GOPATH的/src/github.com/swaggo/swag/cmd/swag路径下执行
go install

2.3.2 生成API文档

cd server
swag init

执行上面的命令后，server目录下会出现docs文件夹，登录 http://localhost :8888/swagger/index.html，即可查看swagger文档

2.4 docker 镜像

感谢 @chenlinzhong 提供的docker镜像. 

# 启动容器
docker run -itd --net=host --name=go_container shareclz/go_node /bin/bash;

# 进入容器
docker exec -it go_container /bin/bash;
git clone https://github.com/piexlmax/gin-vue-admin.git /data1/www/htdocs/go/admin;

# 启动前端
cd /data1/www/htdocs/go/admin/QMPlusVuePage;
cnpm i ;
npm run serve;

# 修改数据库配置
vi /data1/www/htdocs/go/admin/QMPlusServer/static/dbconfig/config.json;

# 启动后端
cd /data1/www/htdocs/go/admin/QMPlusServer;z
go run main.go;

3. 技术选型

vueElement-UIGinGinMySqlgormRedisjwtSwaggerfsnotifyviperyamlgo-logging

4. 项目目录

├─server           （后端文件夹）
    │  ├─api            （API）
    │  ├─config         （配置包）
    │  ├─core              （內核）
    │  ├─db             （数据库脚本）
    │  ├─docs              （swagger文档目录）
    │  ├─global         （全局对象）
    │  ├─initialiaze    （初始化）
    │  ├─middleware     （中间件）
    │  ├─model          （结构体层）
    │  ├─resource       （资源）
    │  ├─router         （路由）
    │  └─utils            （公共功能）
    └─web            （前端文件）
        ├─public        （发布模板）
        └─src           （源码包）
            ├─api       （向后台发送ajax的封装层）
            ├─assets    （静态文件）
            ├─components（组件）
            ├─router    （前端路由）
            ├─store     （vuex 状态管理仓）
            ├─style     （通用样式文件）
            ├─utils     （前端 工具 库）
            └─view      （前端页面）

5. 主要功能

jwtcasbin
前端文件参考: src\view\superAdmin\api\api.vue 
后台文件参考: model\dnModel\api.go
config.yamlsystemuseMultipoint

6. 计划任务

  • [ ] 导入，导出Excel
  • [ ] Echart图表支持
  • [ ] 工作流，任务交接功能开发
  • [ ] 单独前端使用模式以及数据模拟

7. 更新日志

web/src/view/layout/index.vueHistoryComponentbackground

8. 团队博客

9. 教学视频

9.1 环境搭建

Bilibili： https://www.bilibili.com/vide... (v1.0版本视频，v2.0操作相同目录不同)

9.2 模板使用

Bilibili： https://www.bilibili.com/vide... (v1.0版本视频，v2.0操作相同目录不同)

9.3 golang基础教学视频录制中...

- QQ交流群：622360840

- 微信交流群：可以添加上面任意一位开发者，备注"加入gin-vue-admin交流群"

10. 开发者列表

昵称 项目职务 姓
项目发起者 蒋
后台开发 印
全栈开发 严
前端UI开发 杜
前端开发 尹
新手开发 宋

11. 捐赠

如果你觉得这个项目对你有帮助，你可以请作者喝饮料