# easy-admin

**Repository Path**: RicheFactory/easy-admin

## Basic Information

- **Project Name**: easy-admin
- **Description**: 基于 Spring Boot 3 + Vue 3 技术栈打造，面向中小企业业务场景的轻量化快速开发脚手架，采用前后端分离架构设计，内置通用权限管理、代码生成、接口文档、异常处理等企业级核心模块，配置简洁、部署方便，能够有效降低重复开发成本，大幅提升项目启动与迭代效率，真正做到开箱即用、快速落地。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-27
- **Last Updated**: 2026-03-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Easy-Admin-Boot3

基于 Spring Boot 3 + Vue 3 的中小企业快速开发脚手架，前后端分离架构，开箱即用。

## 技术栈

| 层级 | 技术 | 版本 |
|------|------|------|
| 后端框架 | Spring Boot | 3.2.5 |
| JDK | Java | 21 |
| ORM | MyBatis-Flex | 1.9.3 |
| 权限认证 | Sa-Token + JWT | 1.38.0 |
| 数据库 | MySQL | 8.x |
| 缓存 | Redis | - |
| 对象存储 | MinIO | 8.5.10 |
| 接口文档 | Knife4j (OpenAPI3) | 4.5.0 |
| 前端框架 | Vue | 3.4 |
| 构建工具 | Vite | 4.x |
| UI 组件库 | Element Plus | 2.4 |
| 状态管理 | Pinia | 2.x |
| 国际化 | Vue I18n | 9.x |
| 图表 | ECharts | 5.5 |

## 功能模块

- 用户管理 / 角色管理 / 菜单管理
- 部门管理 / 字典管理 / 配置管理
- 数据权限 / 客户端管理
- 代码生成器
- Excel 导入导出（EasyExcel）
- WebSocket 消息推送
- MinIO 文件上传
- 数据大屏

## 项目结构

```
├── src/                          # 后端 Java 源码
│   └── main/
│       ├── java/com/mars/easy/admin/
│       │   ├── framework/        # 框架层（安全、缓存、异常、工具等）
│       │   └── modules/          # 业务模块
│       │       ├── auth/         # 认证
│       │       ├── system/       # 系统管理
│       │       ├── tool/         # 代码生成等工具
│       │       └── business/     # 业务模块
│       └── resources/
│           ├── mapper/           # MyBatis XML
│           └── templates/        # 代码生成模板
├── easy-admin-web/               # 前端 Vue3 项目
│   └── src/
│       ├── api/                  # 接口请求
│       ├── components/           # 公共组件
│       ├── layouts/              # 布局组件
│       ├── router/               # 路由
│       ├── stores/               # Pinia 状态
│       ├── views/                # 页面
│       └── languages/            # 国际化
├── doc/db/                       # 数据库脚本
└── pom.xml
```

## 环境要求

- JDK 21+
- Maven 3.8+
- MySQL 8.x
- Redis
- Node.js 18+（前端）

## 快速开始

### 1. 初始化数据库

创建数据库 `easy-admin`，导入 SQL 脚本：

```sql
source doc/db/easy-admin-boot3.sql
```

### 2. 修改后端配置

编辑 `src/main/resources/application-dev.yml`，修改数据库和 Redis 连接信息：

```yaml
spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/easy-admin?useUnicode=true&characterEncoding=UTF-8&serverTimezone=GMT%2B8
    username: root
    password: your_password
  data:
    redis:
      host: 127.0.0.1
      port: 6379
```

### 3. 启动后端

```bash
mvn spring-boot:run
```

后端默认运行在 `http://localhost:8888/api`

### 4. 启动前端

```bash
cd easy-admin-web
npm install
npm run dev
```

前端默认运行在 `http://localhost:9848`

### 5. 访问接口文档

启动后端后访问：`http://localhost:8888/api/doc.html`

## 构建部署

### 后端打包

```bash
mvn clean package -Dmaven.test.skip=true
java -jar target/easy-admin-boot3-1.0.0-SNAPSHOT.jar
```

### 前端打包

```bash
cd easy-admin-web
npm run build
```

打包产物在 `easy-admin-web/dist` 目录，配合 Nginx 部署即可（参考 `easy-admin-web/nginx/default.conf`）。

## License

MIT