From ffbfceb59c77accb7f137068411232f3a17f2f6c Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Fri, 25 Jul 2025 07:32:06 +0000
Subject: [PATCH] Update README.md

---
 README.en.md | 256 +++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 256 +++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 512 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 00000000..e08b85d7
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,256 @@
+# RuoYi Management System
+
+RuoYi is a backend management system based on Spring Boot, offering functional modules such as user management, role management, menu management, department management, post management, log management, system monitoring, code generation, and multi-data source support. The project features a clear structure, easy extensibility, and is suitable for rapid development of enterprise-level backend management systems.
+
+---
+
+## Functional Modules
+
+### User Management
+- Maintenance of user information
+- Add, edit, and delete users
+- Role assignment for users
+- User status management
+- Import/export of users
+- Password reset for users
+
+### Role Management
+- Add, edit, and delete roles
+- Role permission assignment (menu permissions, data permissions)
+- Role status management
+
+### Menu Management
+- Add, edit, and delete menus
+- Menu permission configuration
+- Icon selection supports Font Awesome
+
+### Department Management
+- Display of department tree structure
+- Add, edit, and delete departments
+- Department status management
+
+### Post Management
+- Maintenance of post information
+- Add, edit, and delete posts
+
+### Parameter Management
+- System parameter configuration
+- Parameter cache refresh
+- Import/export of parameters
+
+### Notifications & Announcements
+- Publish, edit, and delete announcements
+- Announcement viewing
+
+### Log Management
+- Records of login logs and operation logs
+- Export, delete, and clear logs
+
+### System Monitoring
+- Online user management
+- Cache monitoring
+- Service status monitoring
+- Data source monitoring (Druid)
+
+### Code Generation
+- Automatic code generation from table structure
+- Support for generating CRUD functions
+- Support for custom templates
+
+### File Upload
+- Local file upload and download
+- Support for avatar upload and multiple file uploads
+
+### Form Builder
+- Form component display (buttons, dropdowns, date pickers, etc.)
+- Form validation, drag-and-drop sorting, tab panels, etc.
+
+### Table Management
+- Table search, export, fixed columns, sorting, pagination
+- Table editing, sub-tables, virtual scrolling, etc.
+
+### Chart Display
+- Support for ECharts chart display
+- Support for lightweight charts like Sparkline and Peity
+
+### Tool Modules
+- Swagger interface documentation
+- Code building tools
+- Table drag-and-drop, sorting, exporting, printing, etc.
+
+---
+
+## Technology Stack
+
+- **Backend Framework**: Spring Boot, MyBatis, Shiro, Spring Data JPA
+- **Frontend Framework**: Bootstrap, jQuery, Layui, Bootstrap Table, Summernote, ZTree
+- **Database**: MySQL, Oracle, PostgreSQL (supports multiple data sources)
+- **Caching**: Ehcache, Redis
+- **Security Framework**: Apache Shiro
+- **API Documentation**: Swagger UI
+- **Build Tools**: Maven, Gradle
+
+---
+
+## Installation & Deployment
+
+### System Requirements
+
+- JDK 1.8+
+- Maven 3.0+
+- MySQL 5.7+
+- Node.js (for frontend build)
+
+### Backend Deployment
+
+1. Clone the project:
+
+```bash
+git clone https://22520.runjs.cn/gigi-two222/ruoyiruoyi.git
+```
+
+2. Import the database:
+
+```bash
+mysql -u root -p < ruoyi.sql
+```
+
+3. Modify the database configuration:
+
+Edit the file `ruoyi-admin/src/main/resources/application.yml` to configure the database connection.
+
+4. Start the project:
+
+```bash
+cd ruoyi-admin
+mvn spring-boot:run
+```
+
+Access URL: `http://localhost:8080`
+
+### Frontend Deployment (Optional)
+
+1. Install dependencies:
+
+```bash
+npm install
+```
+
+2. Start the development server:
+
+```bash
+npm run dev
+```
+
+3. Build for production:
+
+```bash
+npm run build
+```
+
+---
+
+## Usage Instructions
+
+### Logging Into the System
+
+Visit `http://localhost:8080/login` and log in using the default account:
+
+- Username: admin
+- Password: admin123
+
+### User Management
+
+Path: `System Management -> User Management`
+
+- Supports adding, editing, and deleting users
+- Supports role assignment, status modification, and password reset
+
+### Role Management
+
+Path: `System Management -> Role Management`
+
+- Supports menu permission and data permission configuration
+- Supports role status management
+
+### Menu Management
+
+Path: `System Management -> Menu Management`
+
+- Supports adding, editing, and deleting menus
+- Supports icon selection (Font Awesome)
+
+### Parameter Management
+
+Path: `System Management -> Parameter Management`
+
+- Supports system parameter configuration
+- Supports parameter cache refresh
+
+### Log Management
+
+Path: `Monitoring Management -> Login Logs / Operation Logs`
+
+- View user login records and operation records
+- Supports log export, deletion, and clearing
+
+### System Monitoring
+
+Path: `Monitoring Management -> Online Users / Cache Monitoring / Database Monitoring`
+
+- View current online users
+- View cache status
+- View database connection status (Druid)
+
+---
+
+## Development Standards
+
+- Clear code structure with modular design
+- Use of unified return wrapper class `AjaxResult`
+- Use of `@RequiresPermissions` annotation for permission control
+- Use of `@Log` annotation to record operation logs
+- Use of `@Validated` annotation for parameter validation
+- Use of `@Data` annotation to automatically generate getter/setter/toString methods
+
+---
+
+## Extension Suggestions
+
+- Automatically generate business code via the `ruoyi-generator` module
+- Add scheduled tasks via the `ruoyi-quartz` module
+- Extend system functionality via the `ruoyi-system` module
+- Encapsulate common utility classes via the `ruoyi-common` module
+
+---
+
+## Open Source License
+
+This project uses the [MIT License](https://opensource.org/licenses/MIT). Please retain the project source when using it.
+
+---
+
+## Contact Information
+
+- Project URL: [https://22520.runjs.cn/gigi-two222/ruoyiruoyi](https://22520.runjs.cn/gigi-two222/ruoyiruoyi)
+- Author: RuoYi Development Team
+- QQ Group: 123456789
+- WeChat Official Account: RuoYi Open Source Project
+
+---
+
+## Acknowledgments
+
+Thanks to the support of the following open-source projects:
+
+- Spring Boot
+- MyBatis
+- Bootstrap
+- jQuery
+- Layui
+- Swagger
+- Apache Shiro
+
+---
+
+Contributions of code, issue submissions, and suggestions are welcome!
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..a249cd71
--- /dev/null
+++ b/README.md
@@ -0,0 +1,256 @@
+# RuoYi 管理系统
+
+RuoYi 是一个基于 Spring Boot 的后台管理系统，提供了用户管理、角色管理、菜单管理、部门管理、岗位管理、日志管理、系统监控、代码生成、多数据源等功能模块。该项目结构清晰，易于扩展，适用于企业级后台管理系统的快速开发。
+
+---
+
+## 功能模块
+
+### 用户管理
+- 用户信息维护
+- 用户新增、编辑、删除
+- 用户角色分配
+- 用户状态管理
+- 用户导入/导出
+- 用户密码重置
+
+### 角色管理
+- 角色新增、编辑、删除
+- 角色权限分配（菜单权限、数据权限）
+- 角色状态管理
+
+### 菜单管理
+- 菜单新增、编辑、删除
+- 菜单权限配置
+- 图标选择支持 Font Awesome
+
+### 部门管理
+- 部门树结构展示
+- 部门新增、编辑、删除
+- 部门状态管理
+
+### 岗位管理
+- 岗位信息维护
+- 岗位新增、编辑、删除
+
+### 参数管理
+- 系统参数配置
+- 参数缓存刷新
+- 参数导入/导出
+
+### 通知公告
+- 公告发布、编辑、删除
+- 公告查看
+
+### 日志管理
+- 登录日志、操作日志记录
+- 日志导出、删除、清空
+
+### 系统监控
+- 在线用户管理
+- 缓存监控
+- 服务状态监控
+- 数据源监控（Druid）
+
+### 代码生成
+- 表结构自动生成代码
+- 支持增删改查功能生成
+- 支持自定义模板
+
+### 文件上传
+- 本地文件上传与下载
+- 支持头像上传、多文件上传
+
+### 表单构建
+- 表单控件展示（按钮、下拉框、时间选择器等）
+- 表单验证、拖拽排序、标签面板等
+
+### 表格管理
+- 表格搜索、导出、固定列、排序、分页
+- 表格编辑、子表格、虚拟滚动等
+
+### 图表展示
+- 支持 ECharts 图表展示
+- 支持 Sparkline、Peity 等轻量图表
+
+### 工具模块
+- Swagger 接口文档
+- 代码构建工具
+- 表格拖拽、排序、导出、打印等
+
+---
+
+## 技术栈
+
+- **后端框架**：Spring Boot、MyBatis、Shiro、Spring Data JPA
+- **前端框架**：Bootstrap、jQuery、Layui、Bootstrap Table、Summernote、ZTree
+- **数据库**：MySQL、Oracle、PostgreSQL（支持多数据源）
+- **缓存**：Ehcache、Redis
+- **安全框架**：Apache Shiro
+- **接口文档**：Swagger UI
+- **构建工具**：Maven、Gradle
+
+---
+
+## 安装部署
+
+### 环境要求
+
+- JDK 1.8+
+- Maven 3.0+
+- MySQL 5.7+
+- Node.js（前端构建）
+
+### 后端部署
+
+1. 克隆项目：
+
+```bash
+git clone https://22520.runjs.cn/gigi-two222/ruoyiruoyi.git
+```
+
+2. 导入数据库：
+
+```bash
+mysql -u root -p < ruoyi.sql
+```
+
+3. 修改数据库配置：
+
+编辑 `ruoyi-admin/src/main/resources/application.yml` 文件，配置数据库连接信息。
+
+4. 启动项目：
+
+```bash
+cd ruoyi-admin
+mvn spring-boot:run
+```
+
+访问地址：`http://localhost:8080`
+
+### 前端部署（可选）
+
+1. 安装依赖：
+
+```bash
+npm install
+```
+
+2. 启动开发服务器：
+
+```bash
+npm run dev
+```
+
+3. 构建生产环境：
+
+```bash
+npm run build
+```
+
+---
+
+## 使用说明
+
+### 登录系统
+
+访问 `http://localhost:8080/login`，使用默认账号登录：
+
+- 用户名：admin
+- 密码：admin123
+
+### 用户管理
+
+路径：`系统管理 -> 用户管理`
+
+- 支持新增、编辑、删除用户
+- 支持角色分配、状态修改、密码重置
+
+### 角色管理
+
+路径：`系统管理 -> 角色管理`
+
+- 支持菜单权限、数据权限配置
+- 支持角色状态管理
+
+### 菜单管理
+
+路径：`系统管理 -> 菜单管理`
+
+- 支持菜单新增、编辑、删除
+- 支持图标选择（Font Awesome）
+
+### 参数管理
+
+路径：`系统管理 -> 参数管理`
+
+- 支持系统参数配置
+- 支持参数缓存刷新
+
+### 日志管理
+
+路径：`监控管理 -> 登录日志 / 操作日志`
+
+- 查看用户登录记录、操作记录
+- 支持日志导出、删除、清空
+
+### 系统监控
+
+路径：`监控管理 -> 在线用户 / 缓存监控 / 数据监控`
+
+- 查看当前在线用户
+- 查看缓存状态
+- 查看数据库连接状态（Druid）
+
+---
+
+## 开发规范
+
+- 代码结构清晰，模块化设计
+- 使用统一的返回封装类 `AjaxResult`
+- 使用 `@RequiresPermissions` 注解进行权限控制
+- 使用 `@Log` 注解记录操作日志
+- 使用 `@Validated` 注解进行参数校验
+- 使用 `@Data` 自动生成 getter/setter/toString 等方法
+
+---
+
+## 扩展建议
+
+- 可通过 `ruoyi-generator` 模块自动生成业务代码
+- 可通过 `ruoyi-quartz` 模块添加定时任务
+- 可通过 `ruoyi-system` 模块扩展系统功能
+- 可通过 `ruoyi-common` 模块封装通用工具类
+
+---
+
+## 开源协议
+
+本项目采用 [MIT License](https://opensource.org/licenses/MIT)，请在使用时保留项目出处。
+
+---
+
+## 联系方式
+
+- 项目地址：[https://22520.runjs.cn/gigi-two222/ruoyiruoyi](https://22520.runjs.cn/gigi-two222/ruoyiruoyi)
+- 作者：RuoYi 开发团队
+- QQ 群：123456789
+- 微信公众号：RuoYi 开源项目
+
+---
+
+## 致谢
+
+感谢以下开源项目的支持：
+
+- Spring Boot
+- MyBatis
+- Bootstrap
+- jQuery
+- Layui
+- Swagger
+- Apache Shiro
+
+---
+
+欢迎贡献代码、提交 Issue、提出建议！
\ No newline at end of file
-- 
Gitee