技小云
67 lines
3.3 KiB
Markdown
67 lines
3.3 KiB
Markdown
---
|
|
title: XiuAdmin
|
|
description: 基于 GoFrame2 + Vue3 的全栖中后台框架
|
|
outline: deep
|
|
---
|
|
|
|
# XiuAdmin
|
|
|
|
基于全新 GoFrame2 + Vue3 + VueVbenAdmin 开发的全栖框架，适合大型中后台完整应用开发。
|
|
|
|
| 项 | 值 |
|
|
| --- | --- |
|
|
| 代码仓 | <https://gitee.com/snowgoat/xiu-admin> |
|
|
| 许可证 | Apache-2.0 |
|
|
| 状态 | 已发布 |
|
|
| 技术栈 | GoFrame v2、Vue 3、Vue Vben Admin、Ant Design Vue、asynq |
|
|
|
|
## 框架特征
|
|
|
|
- 高生产率：极强的可扩展性，应用化、模块化、插件化机制敏捷开发，几分钟即可搭建一个应用开发框架
|
|
- 快速生成代码：无需编写代码，只需创建表进行简单配置就能生成完善的 CURD、树表等常用开发代码，所需表单控件也是勾选即可直接生成
|
|
- 认证机制：采用 JWT 的用户状态认证
|
|
- 路由模式：得益于 GoFrame 提供了规范化的路由注册方式，无需注解自动生成 api 文档
|
|
- 模块化设计，面向接口开发
|
|
|
|
## 内置功能
|
|
|
|
1. 租户管理：系统内租户的管理，如租户套餐、过期时间、用户数量、企业信息等
|
|
2. 租户套餐管理：租户所能使用的套餐管理，如套餐内所包含的菜单等
|
|
3. 客户端管理：系统内对接的所有客户端管理，如 pc 端、小程序端等
|
|
4. 用户管理：用户是系统操作者，完成系统用户配置
|
|
5. 部门管理：配置系统组织机构（公司、部门、岗位），树结构展现支持数据权限
|
|
6. 岗位管理：配置系统用户所属担任职务
|
|
7. 菜单管理：配置系统菜单，操作权限、按钮权限标识等
|
|
8. 角色管理：角色菜单权限分配、设置角色按机构或按上下级关系进行数据范围权限划分
|
|
9. 字典管理：对系统中经常使用的一些特定数据进行维护，支持枚举字典和自定义方法字典
|
|
10. 配置管理：对系统动态配置常用参数
|
|
11. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询
|
|
12. 登录日志：系统登录日志记录查询，包含登录异常
|
|
13. 服务日志：服务端运行所产生的警告、异常、崩溃日志的详细数据和堆栈信息
|
|
14. 在线用户：当前系统中活跃用户状态监控
|
|
15. 定时任务：在线（添加、修改、删除）任务调度，包含执行结果日志
|
|
16. 代码生成：支持自动化生成前后端代码。CURD 关联表、树表、消息队列、定时任务一键生成等
|
|
17. 服务监控：监视当前系统 CPU、内存、磁盘、网络、堆栈等相关信息
|
|
18. 缓存监控：对系统的缓存信息查询、命令统计等
|
|
19. 附件管理：文件图片上传，大文件分片上传、断点续传，支持本地
|
|
20. 消息队列：Asynq 消息队列
|
|
21. 通知公告：采用 WebSocket 实时推送在线用户最新通知、公告、私信消息
|
|
22. 常用工具：集成常用的工具包和命令行工具，可以快速开发自定义命令行，多种启动入口
|
|
|
|
## 目录结构
|
|
|
|
```text
|
|
xiu-admin/
|
|
├── server/ # GoFrame 后端服务
|
|
├── vue/ # 前端 pnpm monorepo
|
|
├── docs/ # 文档与演示图例
|
|
├── build/ # 构建脚本
|
|
└── deploy/ # 部署配置
|
|
```
|
|
|
|
## 参与贡献
|
|
|
|
1. Fork 代码仓并创建特性分支
|
|
2. 提交前确保 `go build ./...` 与 `pnpm build` 通过
|
|
3. 提交 Pull Request 并说明变更动机
|