From 70418bfb84c59c3773fae38162d507bdd5b6c9c6 Mon Sep 17 00:00:00 2001
From: lizhw <171332584@qq.com>
Date: Mon, 13 Apr 2026 20:37:15 +0800
Subject: [PATCH] =?UTF-8?q?=E9=85=8D=E7=BD=AE?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
README.md | 373 ++++++++++++++++++++++++++++------------------
README_project.md | 31 ----
2 files changed, 226 insertions(+), 178 deletions(-)
delete mode 100644 README_project.md
diff --git a/README.md b/README.md
index eeb3f7b4b..12d94e3d5 100644
--- a/README.md
+++ b/README.md
@@ -1,182 +1,261 @@
-
-
-
+#### 2. 启动服务
+```bash
+docker-compose up -d
+```
-## 演示图例
+## 目录结构
-| | |
-|--------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------|
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
-|  |  |
+```
+ruoyi-vue-plus/
+├── ruoyi-common/ # 通用模块
+│ ├── ruoyi-common-bom/ # 依赖管理
+│ ├── ruoyi-common-core/ # 核心工具类
+│ ├── ruoyi-common-core-api/ # 核心API
+│ ├── ruoyi-common-security/ # 安全框架
+│ ├── ruoyi-common-redis/ # Redis工具
+│ ├── ruoyi-common-mybatis/ # MyBatis增强
+│ └── ...
+├── ruoyi-modules/ # 业务模块
+│ ├── ruoyi-admin/ # 管理后台
+│ ├── ruoyi-system/ # 系统管理
+│ ├── ruoyi-generator/ # 代码生成器
+│ ├── ruoyi-job/ # 任务调度
+│ ├── ruoyi-md-system/ # 多租户系统管理
+│ ├── ruoyi-md-form/ # 表单管理
+│ ├── ruoyi-md-h5/ # H5应用
+│ └── ...
+├── ruoyi-site/ # 站点模块
+│ ├── ruoyi-admin/ # 管理后台站点
+│ ├── ruoyi-gateway/ # 网关服务
+│ ├── ruoyi-sso-server/ # 单点登录服务
+│ └── ...
+├── ruoyi-extend/ # 扩展模块
+│ ├── ruoyi-snailjob-server/ # 任务调度服务
+│ ├── ruoyi-monitor-admin/ # 监控服务
+│ └── ...
+├── ruoyi-ui/ # 前端代码
+├── docker-compose.yml # Docker-compose配置
+├── pom.xml # Maven配置
+└── README.md # 项目说明
+```
+## 核心模块说明
+### 1. 系统管理(ruoyi-system)
+- 用户管理:用户信息、角色分配、状态管理
+- 角色管理:角色权限配置、菜单分配
+- 部门管理:组织架构维护
+- 菜单管理:动态菜单配置、权限控制
+- 字典管理:系统参数配置、数据字典
+### 2. 工作流(ruoyi-workflow)
+- 流程定义:流程模板设计、部署
+- 流程实例:流程运行状态管理
+- 任务管理:待办任务、已办任务
+- 流程监控:流程执行情况监控
+### 3. 表单管理(ruoyi-md-form)
+- 表单设计:可视化表单设计器
+- 表单配置:表单字段、验证规则配置
+- 表单实例:表单数据管理
+### 4. 多租户(ruoyi-md-system-saas)
+- 租户管理:租户信息、状态管理
+- 租户套餐:租户权限套餐配置
+- 租户菜单:租户菜单权限配置
+## 配置说明
+### 数据源配置
+```yaml
+spring:
+ datasource:
+ url: jdbc:mysql://localhost:3306/ruoyi-vue-plus?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
+ username: root
+ password: 123456
+```
+### Redis配置
+```yaml
+spring:
+ redis:
+ host: localhost
+ port: 6379
+ password:
+ database: 0
+```
+### 微服务配置
+```yaml
+spring:
+ cloud:
+ nacos:
+ discovery:
+ server-addr: localhost:8848
+ config:
+ server-addr: localhost:8848
+ file-extension: yml
+```
+## 开发规范
+### 代码规范
+- 遵循阿里巴巴Java开发手册
+- 代码可读性 > 质量 > 性能 > 安全性
+- 统一的命名规范:类名、方法名、变量名
+- 详细的代码注释
+### 提交规范
+- 提交信息格式:`[模块名] 功能描述`
+- 提交前进行代码检查
+- 定期进行代码Review
+
+## 安全注意事项
+- 密码加密存储
+- 接口权限验证
+- SQL注入防护
+- XSS攻击防护
+- CSRF攻击防护
+- 敏感信息脱敏
+
+## 常见问题
+
+### 1. 启动失败
+- 检查数据库连接
+- 检查Redis服务
+- 检查端口是否被占用
+
+### 2. 权限问题
+- 检查用户角色权限配置
+- 检查菜单权限设置
+
+### 3. 性能问题
+- 检查SQL语句优化
+- 检查Redis缓存使用
+- 检查线程池配置
+
+## 许可证
+
+本项目基于 Apache License 2.0 许可证开源。
+
+## 联系方式
+
+- Gitee: https://gitee.com/xxx/ruoyi-vue-plus
+- 邮箱: xxx@example.com
+
+## 更新日志
+
+### v5.2.2 (2026-04-13)
+- 完善多租户功能
+- 优化工作流模块
+- 新增表单设计器
+- 修复已知bug
+
+### v5.2.1 (2026-03-01)
+- 集成SnailJob任务调度
+- 新增社交登录功能
+- 优化系统性能
+
+### v5.2.0 (2026-01-01)
+- 基于Spring Boot 3.0重构
+- 升级Spring Cloud版本
+- 优化微服务架构
\ No newline at end of file
diff --git a/README_project.md b/README_project.md
deleted file mode 100644
index 3a210ce6b..000000000
--- a/README_project.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# 后端
-
-| 模块 | 主要功能 | 详细描述 | git地址 | | | |
-|------------------|------------|------|-------|---|---|---|
-| gateway | 全局网关 | | | | | |
-| ruoyi-sso-server | sso单点登录服务 | | | | | |
-| ruoyi-h5 | 在线h5微服务 | | | | | |
-| ruoyi-tams | 教培微服务 | | | | | |
-| ruoyi-s3 | s3 对象存储微服务 | | | | | |
-| ruoyi-h5 | 在线h5后台 | | | | | |
-
-# 前端
-
-| 模块 | 主要功能 | 详细描述 | git地址 | | | |
-|---------------|----------|------|-------|---|---|---|
-| tmagic-editor | 在线h5编辑 | | | | | |
-| ruoyi-h5-web | 在线h5管理界面 | | | | | |
-
-## tmagic-editor
-
-### 未来规划
-- 参考 https://www.gaoding.com/editor/odyssey?mode=user&template_id=31593731846159481
-
-- 支持mock 接口
-- 模板模块:支持查询模板、滚动懒加载模板、分类查询模板、模板预览、模板替换当前页面
-- 支持文字、组件
-- 背景替换
-- 支持长页面和翻页页面
-- 全部支持分组和打标签()
-- 方便后面界面优化,是埋点还是怎么弄?
-- 支持全局搜索
\ No newline at end of file