wbr664393425-lgtm/scaffold-master

选用指南

AI 根据 README 整理 · 2026/10/14 18:25:48

适用场景

适用于需要快速搭建后台管理系统的场景，包含认证、权限、组织管理、日志等基础功能。

查看 README 依据

# 通用后台管理脚手架 用于后续后台管理系统开发的 Spring Boot + Vue 底座。包含认证、菜单与按钮权限、数据权限、组织管理、字典、参数、日志、工作台和代码生成骨架；新增项目在此基础上实现业务模块。 ## 开发入口 - [项目地图](PROJECT_MAP.md)：按功能定位页面、接口、服务、SQL 和权限。 - [设计规范](DESIGN.md)：珍珠玻璃主题、组件复用及交互规范。 - [开发约定](AGENTS.md)、[更新日志](changelog.md)。 - [后端架构](docs/backend-architecture.md)、[前后端接口约定](docs/frontend-backend-integration.md)、[前端架构](docs/admin-redesign-architecture.md)。 ## 目录与技术栈 | 目录 | 用途 | 技术栈 | | --- | --- | --- | | `scaffold-system` | 后端 Maven 多模块工程 | Java 17+、Spring Boot 3.5、MyBatis、MySQL、Redis、JWT | | `scaffold-vue` | 管理后台 | Vue 3、TypeScript、Vite 6、Vue Router 4、GSAP 3，自有组件库 |

目标用户

面向需要开发后台管理系统的开发者，提供开发入口和架构文档。

查看 README 依据

# 通用后台管理脚手架 用于后续后台管理系统开发的 Spring Boot + Vue 底座。包含认证、菜单与按钮权限、数据权限、组织管理、字典、参数、日志、工作台和代码生成骨架；新增项目在此基础上实现业务模块。 ## 开发入口 - [项目地图](PROJECT_MAP.md)：按功能定位页面、接口、服务、SQL 和权限。 - [设计规范](DESIGN.md)：珍珠玻璃主题、组件复用及交互规范。 - [开发约定](AGENTS.md)、[更新日志](changelog.md)。 - [后端架构](docs/backend-architecture.md)、[前后端接口约定](docs/frontend-backend-integration.md)、[前端架构](docs/admin-redesign-architecture.md)。 ## 目录与技术栈 | 目录 | 用途 | 技术栈 | | --- | --- | --- | | `scaffold-system` | 后端 Maven 多模块工程 | Java 17+、Spring Boot 3.5、MyBatis、MySQL、Redis、JWT | | `scaffold-vue` | 管理后台 | Vue 3、TypeScript、Vite 6、Vue Router 4、GSAP 3，自有组件库 |

使用方式

通过命令行启动后端和前端，后端使用 Maven 构建，前端使用 npm 运行。

查看 README 依据

首次创建空的 `scaffold_system` 库后，按顺序导入两份 SQL；mysql 客户端须使用 `--default-character-set=utf8mb4`，并通过 `--init-command="SET time_zone='+08:00'"` 设置会话时区。也可在 IDE 运行 `scaffold-admin` 中的 `com.scaffold.admin.util.DbInit`，该工具使用同一组 `DB_*` 变量并按版本顺序初始化；参数 `fix` 会删除整个目标库，仅在核实库名、备份且明确同意重建时使用。 ```bash # 在 scaffold-system 目录构建与启动后端 mvn -pl scaffold-admin -am package -DskipTests java -jar scaffold-admin/target/scaffold-admin-0.1.0-SNAPSHOT.jar ``` ```bash # 在 scaffold-vue 目录启动前端；首次使用先 npm ci npm run dev ``` 浏览器访问 `http://localhost:5173`，后端本地端口为 `8080`；前端统一通过 `/api` 代理访问后端。

部署要求

需要 JDK 17+、Maven、Node.js 22+、MySQL 5.7+ 和 Redis，并配置环境变量如 JWT_SECRET。

查看 README 依据

| `scaffold-system/sql` | 首次初始化脚本 | `V1__init_schema.sql` 建表，`V2__seed_data.sql` 初始化数据 | | `docs` | 当前架构说明 | 后端架构、前后端接口约定和前端组件架构 | 当前包含工作台和 10 个管理页面；建筑、工作流模块已移除。 ## 本地启动 准备 JDK 17 或更新版本、Maven、Node.js 22+、MySQL 5.7+ 和 Redis；前后端依赖均使用项目现有配置。 后端读取进程环境变量，不会自动加载 `.env` 文件；可在 IDE 运行配置或启动终端中设置： | 变量 | 中文说明 | 默认值 | | --- | --- | --- | | `JWT_SECRET` | JWT 签名密钥，至少 32 字节且不能全为空白 | 必填，无默认值 | | `DB_HOST` / `DB_PORT` | MySQL 地址 / 端口 | `localhost` / `3306` | | `DB_NAME` | 数据库名称 | `scaffold_system` | | `DB_USERNAME` / `DB_PASSWORD` | 数据库账号 / 密码 | 本地开发默认账号；按实际环境配置 |

已知限制

代码生成输出为开发骨架，业务 CRUD 和前端页面需自行实现；建筑、工作流模块已移除。

查看 README 依据

| `scaffold-system/sql` | 首次初始化脚本 | `V1__init_schema.sql` 建表，`V2__seed_data.sql` 初始化数据 | | `docs` | 当前架构说明 | 后端架构、前后端接口约定和前端组件架构 | 当前包含工作台和 10 个管理页面；建筑、工作流模块已移除。 ## 本地启动 准备 JDK 17 或更新版本、Maven、Node.js 22+、MySQL 5.7+ 和 Redis；前后端依赖均使用项目现有配置。 后端读取进程环境变量，不会自动加载 `.env` 文件；可在 IDE 运行配置或启动终端中设置： | 变量 | 中文说明 | 默认值 | | --- | --- | --- | | `JWT_SECRET` | JWT 签名密钥，至少 32 字节且不能全为空白 | 必填，无默认值 | | `DB_HOST` / `DB_PORT` | MySQL 地址 / 端口 | `localhost` / `3306` | | `DB_NAME` | 数据库名称 | `scaffold_system` | | `DB_USERNAME` / `DB_PASSWORD` | 数据库账号 / 密码 | 本地开发默认账号；按实际环境配置 |

5. 按角色配置菜单和数据范围，验证低权限账号的真实接口拒绝行为、查询、分页、导出及表单校验。 6. 同步项目地图、相关接口说明和更新日志。 代码生成初始配置为空，按需导入当前数据库的真实表，支持字段信息查看、配置说明保存、7 个文件预览和 ZIP 下载。输出为开发骨架：Controller、Service、Mapper 的业务 CRUD 仍需实现，前端页面需按统一组件规范补齐；下载不会自动写入本工程。 ## 验证 不连接数据库和 Redis 的测试与编译： ```bash # 在 scaffold-system 目录 mvn -pl scaffold-framework -am test mvn -pl scaffold-admin -am package -DskipTests ``` 完整后端集成测试需要配置上述环境变量并准备独立校验库： ```bash # 在 scaffold-system 目录；建议用独立校验库，测试会写入夹具和日志 mvn -pl scaffold-admin -am test ``` ```bash # 在 scaffold-vue 目录 npm run test:unit npm run build # 已安装 Python Playwright 与 Chromium 时，可验证真实浏览器会话与权限