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…

Что это такое?Платформа для разработки админок на полный стек: фронтенд на Vue 3 + Element и бэкенд на Go (Gin), в которых уже подключены аутентификация через JWT, права доступа на casbin, динамические маршруты и меню, а также генераторы кода и форм — так что вы сразу занимаетесь бизнес-логикой, а не шаблонной обвязкой.
Это готовое приложение для развёртывания или фреймворк, на котором я буду строить своё?Это основа для разработки, а не готовый продукт: вы получаете полный исходный код работающего админ-проекта с фронтендом и бэкендом и пишете поверх него свои бизнес-модули. Заточено под быстрый запуск небольших и средних систем.
Как его запустить?Установите Node > v18.16.0 и Go >= v1.22 (рекомендуемая IDE — GoLand), откройте папку server — не корень репозитория — и запустите бэкенд; в прилагаемом рабочем пространстве VSCode есть таск Both (Backend & Frontend), который запускает обе части одновременно.
Что нужно, кроме Node и Go?База данных MySQL или MariaDB (5.7+, InnoDB), с которой работа идёт через GORM, плюс Redis — он хранит JWT-токены активных пользователей, чтобы действовало ограничение на одновременные входы.
Есть ли тут поддержка английского?README двуязычный, но экосистема ориентирована прежде всего на китайский: обучающие видео и видео по развёртыванию размещены на bilibili, а поддержка идёт через группы в QQ и WeChat.
Как именно работает помощь от ИИ?В комплекте есть MCP-сервис, настроенный под ИИ-редакторы, плюс управление навыками из экосистемы Claw (GvaClaw): вы создаёте базовый шаблон, ИИ генерирует структуру, затем появляются код и права доступа — простое CRUD-приложение получается примерно за минуту.
Что ещё есть «из коробки»?Динамические меню, модуль загрузки и скачивания файлов, обёрнутая пагинация, компоненты с управлением видимостью, генератор форм и настраиваемый импорт/экспорт; Swagger собирает документацию по API, zap отвечает за логирование, а viper/fsnotify читают YAML-конфиг.
Мне обязательно использовать TypeScript на фронтенде?Нет — фронтенд позволяет смешивать TypeScript и JavaScript в одном проекте, а интерфейс построен на Vue с библиотекой компонентов Element.
Size
16.7 MB
Stars
25.1K
Age
7y
Commits · 90 Days