加入CODE CHINA

· 不限速    · 不限空间    · 不限人数    · 私仓免费

免费加入
    README.md

    English | 简体中文

    项目文档

    在线文档 : https://www.gin-vue-admin.com/

    开发教学 (贡献者: LLemonGreen And Fann)

    1. 基本介绍

    1.1 项目介绍

    在线预览

    测试用户名:admin

    测试密码:123456

    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 版本列表

    2. 使用说明

    - node版本 > v8.6.0
    - golang版本 >= v1.11
    - IDE推荐:Goland
    - 各位在clone项目以后,把db文件导入自己创建的库后,最好前往七牛云申请自己的空间地址。
    - gormv2版本初始化数据库可以利用批量创建功能,这里已经写好初始化代码,需要在main.go内打开 initialize.Data() 的注释即可
    - 替换掉项目中的七牛云公钥,私钥,仓名和默认url地址,以免发生测试文件数据错乱

    使用docker-compose体验本项目

    • 安装 docker-compose 官方文档

    • 使用git克隆本项目

      •   git clone https://github.com/flipped-aurora/gin-vue-admin.git
    • 使用docker-compose up一键启动启动项目

      • # 使用docker-compose启动四个容器
        docker-compose up
        # 如果您修改了某些配置选项,可以使用此命令重新打包镜像
        docker-compose up --build
        # 使用docker-compose 后台启动
        docker-compose up -d
      • web项目预览 http://127.0.0.1:8000

      • swagger文档 http://127.0.0.1:8888/swagger/index.html

    • 如果server的177.7.0.12这个容器内部ip被占用了,需要修改地方为

    • docker-compose使用自定义的一个docker网络

      •   networks:
            network:
              ipam:
                driver: default
                config:
                  - subnet: '177.7.0.0/16' 
      • 子网地址, 默认网关是177.7.0.1(docker-compose V2需要写,V3则不需要),具体信息看官方文档

      • 默认的network名为gin-vue-admin_network,默认是bridge模式

      • 如果修改了子网,对应的每个service的ipv4_address都需要修改,还有.docker-compose/nginx/conf.d/my.conf的第20行的server的ip也需要修改

    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 包下面的东西,推荐使用 goproxy.io

    如果您使用的 Go 版本是 1.13 及以上(推荐)
    # 启用 Go Modules 功能
    go env -w GO111MODULE=on 
    # 配置 GOPROXY 环境变量
    go env -w GOPROXY=https://goproxy.io,direct
    
    # 执行
    go 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. 技术选型

    • 前端:用基于vueElement-UI构建基础页面。
    • 后端:用Gin快速搭建基础restful风格API,Gin是一个go语言编写的Web框架。
    • 数据库:采用MySql(5.6.44)版本,使用gorm实现对数据库的基本操作,已添加对sqlite数据库的支持。
    • 缓存:使用Redis实现记录当前活跃用户的jwt令牌并实现多点登录限制。
    • API文档:使用Swagger构建自动化文档。
    • 配置文件:使用fsnotifyviper实现yaml格式的配置文件。
    • 日志:使用go-logging实现日志记录。

    4. 项目架构

    4.1 系统架构图

    系统架构图

    4.2 前端详细设计图 (提供者:baobeisuper

    前端详细设计图

    4.3 目录结构

        ├─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. 主要功能

    • 权限管理:基于jwtcasbin实现的权限管理
    • 文件上传下载:实现基于七牛云的文件上传操作(为了方便大家测试,我公开了自己的七牛测试号的各种重要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交流群:622360840

    QQ 群(满)

    微信交流群

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

    8.2 项目组成员

    昵称 项目职务
    @piexlmax 项目发起者
    @Ruio9244 架构师
    @granty1 后台开发
    @1319612909 前端UI开发
    @krank666 前端开发
    @chen-chen-up 新手开发
    @SliverHorn 社区管理员

    9. 捐赠

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

    10. 商用注意事项

    如果您将此项目用于商业用途,请遵守Apache2.0协议并保留作者技术支持声明。

    项目简介

    基于gin+vue搭建的后台管理系统框架,集成jwt鉴权,权限管理,动态路由,分页封装,多点登录拦截,资源权限,上传下载,代码生成器,表单生成器等基础功能,五分钟一套CURD前后端代码包含数据库的快感你不要体验一下吗~,更多功能正在开发中,欢迎issue和pr~

    发行版本

    当前项目没有发行版本

    贡献者 27

    全部贡献者

    开发语言

    • Go 49.5 %
    • Vue 33.8 %
    • JavaScript 6.5 %
    • CSS 5.9 %
    • Smarty 3.1 %