gin-vue-admin README

The project's README from github.com/flipped-aurora/gin-vue-admin. As one markdown file: README.md.


Trendshift

English | 简体中文

支持 Claw 生态

🦞 GvaClaw

一分钟生成前后端基础代码

⭐️ 高度适配AI编辑器的MCP

📄 创建基础模板

🤖 AI生成结构

⏰ 生成代码

🏷️ 分配权限

🎉 基础CURD生成完成

项目文档

在线演示

想了解授权版提供的完整体验，可先访问授权版演示站；如需授权版功能或官方商业支持，请购买商业授权。

重要提示

  1. 本项目从起步到开发到部署均有文档和详细视频教程。
  2. 本项目需要您有一定的 golang 和 vue 基础。
  3. 您完全可以通过我们的教程和文档完成一切操作，因此我们不再提供免费的技术服务，如需服务请进行付费支持。
  4. 本项目采用 Apache License 2.0 开源许可。使用、修改和分发本项目时，请遵循仓库中的 LICENSE，并保留许可证要求的适用声明；如需授权版功能或官方商业支持，请购买授权。

登录界面 仪表盘

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 规范

1.2.2 Pull Request 规范

2. 使用说明

2.1 server项目

使用 Goland 等编辑工具，打开server目录，不可以打开 gin-vue-admin 根目录

# 克隆项目
git clone https://github.com/flipped-aurora/gin-vue-admin.git
# 进入server文件夹
cd server

# 使用 go mod 并安装go依赖包
go generate

# 运行
go run .

2.2 web项目

# 进入web文件夹
cd web

# 安装依赖
npm install

# 启动web项目
npm run serve

2.3 swagger自动化API文档

2.3.1 安装 swagger

go install github.com/swaggo/swag/cmd/swag@latest

2.3.2 生成API文档

cd server
swag init

执行上面的命令后，server目录下会出现docs文件夹里的 docs.go, swagger.json, swagger.yaml 三个文件更新，启动go服务之后, 在浏览器输入 http://localhost:8888/swagger/index.html 即可查看swagger文档

2.4 VSCode工作区

2.4.1 开发

使用 VSCode 打开根目录下的工作区文件 gin-vue-admin.code-workspace，在边栏可以看到三个虚拟目录：backend、frontend、root。

2.4.2 运行/调试

在运行和调试中也可以看到三个 task：Backend、Frontend、Both (Backend & Frontend)。运行 Both (Backend & Frontend) 可以同时启动前后端项目。

2.4.3 settings

在工作区配置文件中有 go.toolsEnvVars 字段，是用于 VSCode 自身的 go 工具环境变量。此外在多 go 版本的系统中，可以通过 gopath、go.goroot 指定运行版本。

    "go.gopath": null,
    "go.goroot": null,

3. 技术选型

4. 项目架构

4.1 系统架构图

系统架构图

4.2 详细设计图 （提供者:baobeisuper）

详细设计图

4.3 目录结构

(详细目录结构请见源码...)

5. 主要功能

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
  4. gin框架基础教学: bilibili
  5. gin-vue-admin 版本更新介绍视频: bilibili

7. 联系方式

微信交流群

防止广告进群，添加微信，输入以下代码执行结果（请勿转码为string）：

str := "5Yqg5YWlR1ZB5Lqk5rWB576k"
decodeBytes, err := base64.StdEncoding.DecodeString(str)
fmt.Println(decodeBytes, err)

8. 贡献者

感谢您对gin-vue-admin的贡献!

Contribution Leaderboard

9. 捐赠

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

10. 注意事项

请遵守 Apache License 2.0，并按许可证要求保留适用的版权、专利、商标和归属声明。 授权版功能与官方商业支持请通过商业授权页面获取。

gin-vue-admin (flipped-aurora/gin-vue-admin)

Searching Database…

25.1K ·GitHub
Gin-vue-admin
这是什么东西？一个全栈后台开发平台：前端是 Vue 3 + Element，后端是 Go（Gin），预先集成了 JWT 认证、casbin 权限管理、动态路由和菜单，还有代码和表单生成器，让你直接从业务逻辑写起，不用先搭一遍脚手架。
这是可以直接部署的成品应用，还是用来做二次开发的框架？它是用来在上面开发的底座，不是成品：你会拿到一个可用的前后台管理项目的完整源码，然后在它上面开发自己的业务模块，目标是快速搭建中小型系统。
我怎么把它跑起来？安装 Node > v18.16.0 和 Go >= v1.22（推荐用 GoLand 作为 IDE），打开 server 目录——注意不是仓库根目录——运行后端；自带的 VSCode 工作区里有一个 Both (Backend & Frontend) 任务，可以一次性同时启动前后端。
除了 Node 和 Go，还需要什么？需要一个 MySQL 或 MariaDB 数据库（5.7+，InnoDB），通过 GORM 来操作，另外还要 Redis，它用来记录在线用户的 JWT token，以实现单点登录限制。
这个项目对英文用户友好吗？README 是双语的，但整个生态以中文为主：教程和部署视频都放在 bilibili 上，技术支持也是通过 QQ 群和微信群进行的。
AI 辅助功能具体是怎么用的？它内置了一个为 AI 编辑器调优的 MCP 服务，以及 Claw 生态的技能管理（GvaClaw）：你先创建一个基础模板，AI 生成整体结构，接着代码和权限跟着补齐——大约一分钟就能做出一个基本的 CRUD 应用。
还有哪些开箱即用的功能？动态菜单、上传下载模块、封装好的分页、可控制可见性的组件、表单生成器和可配置的导入导出；API 文档由 Swagger 生成，日志用 zap，YAML 配置由 viper/fsnotify 读取。
前端必须用 TypeScript 吗？不必须——前端支持在同一个项目里混用 TypeScript 和 JavaScript，界面基于 Vue 和 Element 组件库构建。
What are similar projects?go-admin, eladmin, vue-admin-better, JeecgBoot, directus, vue-manage-system, newbee-mall, open-saas
Which topics is it in?gin, vibecoding, vue-admin, element-ui, swagger, access-control, admin, mariadb, vue3, jwt, boilerplate, full-stack
Creator
flipped-aurora
Size
16.7 MB
Stars
25.1K
Updated
CommitOct 14Releasev2.9.2-stableJul 17
Age
7y
Commits · 90 Days