English | 简体中文
项目文档
- 前端UI框架: element-ui
- 后台框架: gin
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 规范
-
请先 fork 一份到自己的项目下,不要直接在仓库下建分支。
-
commit 信息要以
[文件名]: 描述信息
的形式填写,例如README.md: fix xxx bug
。 -
确保 PR 是提交到
develop
分支,而不是master
分支。 -
如果是修复 bug,请在 PR 中给出描述信息。
-
合并代码需要两名维护人员参与:一人进行 review 后 approve,另一人再次 review,通过后即可合并。
1.3 版本列表
-
master: 2.0, 用于生产环境
-
develop: 2.0, 用于测试环境
-
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推荐:Goland - 各位在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)无法翻墙
由于国内没法安装 go.org/x 包下面的东西,需要先安装 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文档
3. 技术选型
- 前端:用基于
vue
的Element-UI
构建基础页面。 - 后端:用
Gin
快速搭建基础restful风格API,Gin
是一个go语言编写的Web框架。 - 数据库:采用
MySql
(5.6.44)版本,使用gorm
实现对数据库的基本操作,已添加对 sqlite 数据库的支持。 - 缓存:使用
Redis
实现记录当前活跃用户的jwt
令牌并实现多点登录限制。 - API文档:使用
Swagger
构建自动化文档。 - 配置文件:使用
fsnotify
和viper
实现yaml
格式的配置文件。 - 日志:使用
go-logging
实现日志记录。
4. 项目架构
├─server (后端文件夹) │ ├─api (API) │ ├─config (配置包) │ ├─core (內核) │ ├─db (数据库脚本) │ ├─docs (swagger文档目录) │ ├─global (全局对象) │ ├─initialiaze (初始化) │ ├─middleware (中间件) │ ├─model (结构体层) │ ├─resource (资源) │ ├─router (路由) │ ├─service (服务) │ └─utils (公共功能) └─web (前端文件) ├─public (发布模板) └─src (源码包) ├─api (向后台发送ajax的封装层) ├─assets (静态文件) ├─components(组件) ├─router (前端路由) ├─store (vuex 状态管理仓) ├─style (通用样式文件) ├─utils (前端 工具 库) └─view (前端页面)
5. 主要功能
- 权限管理:基于
jwt
和casbin
实现的权限管理 - 文件上传下载:实现基于七牛云的文件上传操作(为了方便大家测试,我公开了自己的七牛测试号的各种重要token,恳请大家不要乱传东西)
- 分页封装:前端使用mixins封装分页,分页方法调用mixins即可
- 用户管理:系统管理员分配用户角色和角色权限。
- 角色管理:创建权限控制的主要对象,可以给角色分配不同api权限和菜单权限。
- 菜单管理:实现用户动态菜单配置,实现不同角色不同菜单。
- api管理:不同用户可调用的api接口的权限不同。
- 配置管理:配置文件可前台修改(测试环境不开放此功能)。
- 富文本编辑器:MarkDown编辑器功能嵌入。
- 条件搜索:增加条件搜索示例。
- restful示例:可以参考用户管理模块中的示例API。
前端文件参考: src\view\superAdmin\api\api.vue 后台文件参考: model\dnModel\api.go
- 多点登录限制:需要在
config.yaml
中把system
中的useMultipoint
修改为true(需要自行配置 Redis 和Config中的Redis参数,测试阶段,有bug请及时反馈)。 - 分片长传:提供文件分片上传和大文件分片上传功能示例。
- 表单生成器:表单生成器借助 @form-generator 。
- 代码生成器:后台基础逻辑以及简单curd的代码生成器。
6. 计划任务
- 导入,导出Excel
- Echart图表支持
- 工作流,任务交接功能开发
- 单独前端使用模式以及数据模拟
7. 知识库
7.1 团队博客
https://www.yuque.com/flipped-aurora
内有前端框架教学视频。如果觉得项目对您有所帮助可以添加我的个人微信:shouzi_1994,欢迎您提出宝贵的需求。
7.2 教学视频
(1)环境搭建
Bilibili: https://www.bilibili.com/video/BV1Fg4y187Bw/ (v1.0版本视频,v2.0操作相同目录不同)
(2)模板使用
Bilibili: https://www.bilibili.com/video/BV16K4y1r7BD/ (v1.0版本视频,v2.0操作相同目录不同)
(3)2.0目录以及开发体验
Bilibili: https://www.bilibili.com/video/BV1aV411d7Gm#reply2831798461
(4)golang基础教学视频录制中...
https://space.bilibili.com/322210472/channel/detail?cid=108884
8. 联系方式
8.1 技术群
QQ群 |
---|
QQ交流群:622360840
微信交流群:可以添加上面任意一位开发者,备注"加入gin-vue-admin交流群"
8.2 项目组成员
蒋 | 尹 | 严 | 杜 | 印 | 宋 |
---|---|---|---|---|---|
昵称 | 项目职务 | 姓 |
---|---|---|
@piexlmax | 项目发起者 | 蒋 |
@granty1 | 后台开发 | 印 |
@Ruio9244 | 全栈开发 | 严 |
@1319612909 | 前端UI开发 | 杜 |
@krank666 | 前端开发 | 尹 |
@chen-chen-up | 新手开发 | 宋 |
9. 捐赠
如果你觉得这个项目对你有帮助,你可以请作者喝饮料
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持 码农网
猜你喜欢:- React后台框架搭建
- 从零开始搭建创业公司后台技术栈
- 使用 JS 搭建网站后台的那些技术
- 使用GoAdmin极速搭建golang应用管理后台
- 使用React全家桶搭建一个后台管理系统
- 「小程序JAVA实战」springboot的后台搭建(30)
本站部分资源来源于网络,本站转载出于传递更多信息之目的,版权归原作者或者来源机构所有,如转载稿涉及版权问题,请联系我们。