Gin Vue Admin

English | 简体中文

支持 Claw 生态

🦞 GvaClaw

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

</td>

项目文档

• 在线文档: https://www.gin-vue-admin.com
• 初始化指南: 点击查看
• 从环境到部署教学视频: bilibili
• 开发教学: 开发教学说明 (贡献者: LLemonGreen And Fann)
• 交流社区: 点击进入
• 插件市场: 点击进入
• 软件著作权证书: 查看证书

在线演示

• 演示站: http://demo.gin-vue-admin.com
• 授权版演示站: https://vip.gin-vue-admin.com
• 演示站测试用户名: admin
• 演示站测试密码: 123456

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

重要提示

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

• issue 仅用于提交 Bug 或 Feature 以及设计相关的内容，其它内容可能会被直接关闭。
• 在提交 issue 之前，请搜索相关内容是否已被提出。

1.2.2 Pull Request 规范

• 请先 fork 一份到自己的项目下，不要直接在仓库下建分支。
• commit 信息要以 [文件名]: 描述信息 的形式填写，例如 README.md: fix xxx bug。
• 如果是修复 bug，请在 PR 中给出描述信息。
• 合并代码需要两名维护人员参与：一人进行 review 后 approve，另一人再次 review，通过后即可合并。

2. 使用说明

• node版本 > v18.16.0
• golang版本 >= v1.22
• IDE推荐：Goland

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. 技术选型