[English](./README-en.md) | 简体中文 [gitee地址](https://gitee.com/pixelmax/gin-vue-admin): https://gitee.com/pixelmax/gin-vue-admin [github地址](https://github.com/flipped-aurora/gin-vue-admin): https://github.com/flipped-aurora/gin-vue-admin [插件仓库以及开发规范](https://github.com/flipped-aurora/gva-plugins):https://github.com/flipped-aurora/gva-plugins [审批流分支](https://github.com/flipped-aurora/gin-vue-admin/tree/gva_workflow): https://github.com/flipped-aurora/gin-vue-admin/tree/gva_workflow [setup语法糖版本地址](https://github.com/flipped-aurora/gin-vue-admin/tree/gva-vue3-setup): https://github.com/flipped-aurora/gin-vue-admin/tree/gva-vue3-setup # 项目文档 [在线文档](https://www.gin-vue-admin.com) : https://www.gin-vue-admin.com [初始化](https://www.gin-vue-admin.com/docs/first_master) [从环境到部署教学视频](https://www.bilibili.com/video/BV1Rg411u7xH) [开发教学](https://www.gin-vue-admin.com/docs/help) (贡献者: LLemonGreen And Fann) [交流社区](https://support.qq.com/products/371961) # 重要提示 1.本项目从起步到开发到部署均有文档和详细视频教程 2.本项目需要您有一定的golang和vue基础 3.您完全可以通过我们的教程和文档完成一切操作，因此我们不再提供免费的技术服务，如需服务请进行[付费支持](https://www.gin-vue-admin.com/docs/payment) 4.如果您将此项目用于商业用途，请遵守Apache2.0协议并保留作者技术支持声明。您需保留如下版权声明信息，其余信息功能不做任何限制。如需剔除请联系微信：shouzi_1994 5.如果您需要服务器的话 2C4G8M 80GB 腾讯云 一年74 三年222 在这里购买：https://curl.qcloud.com/sArxMfaw ## 1. 基本介绍 ### 1.1 项目介绍 > Gin-vue-admin是一个基于 [vue](https://vuejs.org) 和 [gin](https://gin-gonic.com) 开发的全栈前后端分离的开发基础平台，集成jwt鉴权，动态路由，动态菜单，casbin鉴权，表单生成器，代码生成器等功能，提供多种示例文件，让您把更多时间专注在业务开发上。 [在线预览](http://demo.gin-vue-admin.com): http://demo.gin-vue-admin.com 测试用户名：admin 测试密码：123456 ### 1.2 贡献指南 Hi! 首先感谢你使用 gin-vue-admin。 Gin-vue-admin 是一套为快速研发准备的一整套前后端分离架构式的开源框架，旨在快速搭建中小型项目。 Gin-vue-admin 的成长离不开大家的支持，如果你愿意为 gin-vue-admin 贡献代码或提供建议，请阅读以下内容。 #### 1.2.1 Issue 规范 - issue 仅用于提交 Bug 或 Feature 以及设计相关的内容，其它内容可能会被直接关闭。如果你在使用时产生了疑问，请到 Slack 或 [Gitter](https://gitter.im/ElemeFE/element) 里咨询。 - 在提交 issue 之前，请搜索相关内容是否已被提出。 #### 1.2.2 Pull Request 规范 - 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。 - commit 信息要以`[文件名]: 描述信息` 的形式填写，例如 `README.md: fix xxx bug`。 - 确保 PR 是提交到 `develop` 分支，而不是 `master` 分支。 - 如果是修复 bug，请在 PR 中给出描述信息。 - 合并代码需要两名维护人员参与：一人进行 review 后 approve，另一人再次 review，通过后即可合并。 ## 2. 使用说明 ``` - node版本 > v12.18.3 - golang版本 >= v1.16 - IDE推荐：Goland - 初始化项目： 不同版本数据库初始化不通 参见 https://www.gin-vue-admin.com/docs/first_master - 替换掉项目中的七牛云公钥，私钥，仓名和默认url地址，以免发生测试文件数据错乱 ``` ### 2.1 server项目 使用 `Goland` 等编辑工具，打开server目录，不可以打开 gin-vue-admin 根目录 ```bash # 克隆项目 git clone https://github.com/flipped-aurora/gin-vue-admin.git # 进入server文件夹 cd server # 使用 go mod 并安装go依赖包 go generate # 编译 go build -o server main.go (windows编译命令为go build -o server.exe main.go ) # 运行二进制 ./server (windows运行命令为 server.exe) ``` ### 2.2 web项目 ```bash # 进入web文件夹 cd web # 安装依赖 cnpm install || npm install # 启动web项目 npm run serve ``` ### 2.3 swagger自动化API文档 #### 2.3.1 安装 swagger ##### （1）可以访问外国网站 ```` go get -u github.com/swaggo/swag/cmd/swag ```` ##### （2）无法访问外国网站 由于国内没法安装 go.org/x 包下面的东西，推荐使用 [goproxy.cn](https://goproxy.cn) 或者 [goproxy.io](https://goproxy.io/zh/) ```bash # 如果您使用的 Go 版本是 1.13 - 1.15 需要手动设置GO111MODULE=on, 开启方式如下命令, 如果你的 Go 版本 是 1.16 ~ 最新版 可以忽略以下步骤一 # 步骤一、启用 Go Modules 功能 go env -w GO111MODULE=on # 步骤二、配置 GOPROXY 环境变量 go env -w GOPROXY=https://goproxy.cn,https://goproxy.io,direct # 如果嫌弃麻烦,可以使用go generate 编译前自动执行代码, 不过这个不能使用 `Goland` 或者 `Vscode` 的 命令行终端 cd server go generate -run "go env -w .*?" # 使用如下命令下载swag go get -u github.com/swaggo/swag/cmd/swag ``` #### 2.3.2 生成API文档 ```` shell cd server swag init ```` > 执行上面的命令后，server目录下会出现docs文件夹里的 `docs.go`, `swagger.json`, `swagger.yaml` 三个文件更新，启动go服务之后, 在浏览器输入 [http://localhost:8888/swagger/index.html](http://localhost:8888/swagger/index.html) 即可查看swagger文档 ## 3. 技术选型 - 前端：用基于 [Vue](https://vuejs.org) 的 [Element](https://github.com/ElemeFE/element) 构建基础页面。 - 后端：用 [Gin](https://gin-gonic.com/) 快速搭建基础restful风格API，[Gin](https://gin-gonic.com/) 是一个go语言编写的Web框架。 - 数据库：采用`MySql`(5.6.44)版本，使用 [gorm](http://gorm.cn) 实现对数据库的基本操作。 - 缓存：使用`Redis`实现记录当前活跃用户的`jwt`令牌并实现多点登录限制。 - API文档：使用`Swagger`构建自动化文档。 - 配置文件：使用 [fsnotify](https://github.com/fsnotify/fsnotify) 和 [viper](https://github.com/spf13/viper) 实现`yaml`格式的配置文件。 - 日志：使用 [zap](https://github.com/uber-go/zap) 实现日志记录。 ## 4. 项目架构 ### 4.1 系统架构图 ![系统架构图](http://qmplusimg.henrongyi.top/gva/gin-vue-admin.png) ### 4.2 前端详细设计图 （提供者:baobeisuper） ![前端详细设计图](http://qmplusimg.henrongyi.top/naotu.png) ### 4.3 目录结构 ``` ├── server ├── api (api层) │ └── v1 (v1版本接口) ├── config (配置包) ├── core (核心文件) ├── docs (swagger文档目录) ├── global (全局对象) ├── initialize (初始化) │ └── internal (初始化内部函数) ├── middleware (中间件层) ├── model (模型层) │ ├── request (入参结构体) │ └── response (出参结构体) ├── packfile (静态文件打包) ├── resource (静态资源文件夹) │ ├── excel (excel导入导出默认路径) │ ├── page (表单生成器) │ └── template (模板) ├── router (路由层) ├── service (service层) ├── source (source层) └── utils (工具包) ├── timer (定时器接口封装) └── upload (oss接口封装) └─web （前端文件） ├─public （发布模板） └─src （源码包） ├─api （向后台发送ajax的封装层） ├─assets （静态文件） ├─components（组件） ├─router （前端路由） ├─store （vuex 状态管理仓） ├─style （通用样式文件） ├─utils （前端工具库） └─view （前端页面） ``` ## 5. 主要功能 - 权限管理：基于`jwt`和`casbin`实现的权限管理。 - 文件上传下载：实现基于`七牛云`, `阿里云`, `腾讯云` 的文件上传操作(请开发自己去各个平台的申请对应 `token` 或者对应`key`)。 - 分页封装：前端使用 `mixins` 封装分页，分页方法调用 `mixins` 即可。 - 用户管理：系统管理员分配用户角色和角色权限。 - 角色管理：创建权限控制的主要对象，可以给角色分配不同api权限和菜单权限。 - 菜单管理：实现用户动态菜单配置，实现不同角色不同菜单。 - api管理：不同用户可调用的api接口的权限不同。 - 配置管理：配置文件可前台修改(在线体验站点不开放此功能)。 - 条件搜索：增加条件搜索示例。 - restful示例：可以参考用户管理模块中的示例API。 - 前端文件参考: [web/src/view/superAdmin/api/api.vue](https://github.com/flipped-aurora/gin-vue-admin/blob/master/web/src/view/superAdmin/api/api.vue) - 后台文件参考: [server/router/sys_api.go](https://github.com/flipped-aurora/gin-vue-admin/blob/master/server/router/sys_api.go) - 多点登录限制：需要在`config.yaml`中把`system`中的`use-multipoint`修改为true(需要自行配置Redis和Config中的Redis参数，测试阶段，有bug请及时反馈)。 - 分片长传：提供文件分片上传和大文件分片上传功能示例。 - 表单生成器：表单生成器借助 [@form-generator](https://github.com/JakHuang/form-generator) 。 - 代码生成器：后台基础逻辑以及简单curd的代码生成器。 ## 6. 知识库 ## 6.1 团队博客 > https://www.yuque.com/flipped-aurora > >内有前端框架教学视频。如果觉得项目对您有所帮助可以添加我的个人微信:shouzi_1994，欢迎您提出宝贵的需求。 ## 6.2 教学视频 （1）手把手教学视频 > https://www.bilibili.com/video/BV1Rg411u7xH/ （2）后端目录结构调整介绍以及使用方法 > https://www.bilibili.com/video/BV1x44y117TT/ （3）golang基础教学视频 > bilibili：https://space.bilibili.com/322210472/channel/detail?cid=108884 （4）gin框架基础教学 > bilibili：https://space.bilibili.com/322210472/channel/detail?cid=126418&ctype=0 （5）gin-vue-admin 版本更新介绍视频 > bilibili：https://space.bilibili.com/322210472/channel/detail?cid=126418&ctype=0 ## 7. 联系方式 ### 7.1 技术群 ### QQ交流群：622360840 | QQ 群 | | :---: | | | ### 微信交流群 | 微信 | | :---: | | 添加微信，备注"加入gin-vue-admin交流群" ### [关于我们](https://www.gin-vue-admin.com/about/) ## 8. 贡献者 感谢您对gin-vue-admin的贡献! ## 9. 捐赠 如果你觉得这个项目对你有帮助，你可以请作者喝饮料 :tropical_drink: [点我](https://www.gin-vue-admin.com/docs/coffee) ## 10. 商用注意事项 如果您将此项目用于商业用途，请遵守Apache2.0协议并保留作者技术支持声明。