# open-admin 文档

open-admin 是一个**可嵌入**的后台管理系统框架（脚手架）。业务项目通过 Maven 和 npm 添加依赖即可获得完整的后台管理能力，无需从零搭建用户管理、角色权限、数据字典等功能。

## 文档导航

### 入门

- **[快速开始](./quick-start.md)** — 环境搭建、基础使用和集成到已有项目
- **[架构设计](./architecture.md)** — 系统架构和设计理念

### 核心功能

- **[用户权限管理](./core-features/user-permission.md)** — 用户、角色、权限体系
- **[数据字典管理](./core-features/data-dict.md)** — 统一的数据字典维护和使用

### API / 前端

- **[组件库](./api/frontend/components.md)** — ProTable、Page 等核心组件
- **[字段组件](./api/frontend/field-components.md)** — 表单字段组件
- **[系统组件](./api/frontend/system-components.md)** — ButtonList、HasPerm、View 系列
- **[工具类](./api/frontend/utils.md)** — HttpUtils、DateUtils 等

### API / 后端

- **[Spec 动态查询](./api/backend/data-spec.md)** — JPA Spec 动态查询构建器
- **[工具类](./api/backend/utils.md)** — ExcelTool、JdbcUtils、LoginTool、TreeTool 等
- **[注解](./api/backend/annotations.md)** — ID 生成、作业调度等注解
- **[验证器](./api/backend/validators.md)** — 手机号、身份证等校验注解
- **[作业调度](./api/backend/job.md)** — Quartz 定时任务

### 开发指南

- **[编码规范](./development/coding-standard.md)** — 后端和前端编码标准
- **[最佳实践](./development/best-practices.md)** — 开发最佳实践
- **`/open-admin` Skill** — 使用 `/open-admin` 指令创建 CRUD 业务模块

## 系统要求

- **JDK 21+** — 后端开发和运行环境
- **MySQL 8.0+** — 数据存储
- **Node.js 18+** — 前端开发环境
- **npm 9+** — 前端包管理工具

## 技术栈

| 层级 | 技术 |
|------|------|
| 前端 | React 19, Ant Design 6, UmiJS 4 |
| 后端 | Java 21, Spring Boot 4.0, JPA (Hibernate), Spring Security, Quartz |
| 数据库 | MySQL 8+ |
| 构建 | Maven (后端), npm (前端) |