Commit b7380019baec326038d48fb256cbb6d52d78717d

Authored by YunaiV
1 parent a83b8e8f

完善项目 README 说明

Showing 1 changed file with 56 additions and 54 deletions
README.md
@@ -25,7 +25,7 @@ @@ -25,7 +25,7 @@
25 25
26 * 管理后台的 Vue3 版本采用 [vue-element-plus-admin](https://gitee.com/kailong110120130/vue-element-plus-admin) ,Vue2 版本采用 [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin) 26 * 管理后台的 Vue3 版本采用 [vue-element-plus-admin](https://gitee.com/kailong110120130/vue-element-plus-admin) ,Vue2 版本采用 [vue-element-admin](https://github.com/PanJiaChen/vue-element-admin)
27 * 管理后台的移动端采用 [uni-app](https://github.com/dcloudio/uni-app) 方案,一份代码多终端适配,同时支持 APP、小程序、H5! 27 * 管理后台的移动端采用 [uni-app](https://github.com/dcloudio/uni-app) 方案,一份代码多终端适配,同时支持 APP、小程序、H5!
28 -* 后端采用 Spring Boot、MySQL + MyBatis Plus、Redis + Redisson 28 +* 后端采用 Spring Boot 多模块架构、MySQL + MyBatis Plus、Redis + Redisson
29 * 数据库可使用 MySQL、Oracle、PostgreSQL、SQL Server、MariaDB、国产达梦 DM、TiDB 等 29 * 数据库可使用 MySQL、Oracle、PostgreSQL、SQL Server、MariaDB、国产达梦 DM、TiDB 等
30 * 权限认证使用 Spring Security & Token & Redis,支持多终端、多种用户的认证系统,支持 SSO 单点登录 30 * 权限认证使用 Spring Security & Token & Redis,支持多终端、多种用户的认证系统,支持 SSO 单点登录
31 * 支持加载动态权限菜单,按钮级别权限控制,本地缓存提升性能 31 * 支持加载动态权限菜单,按钮级别权限控制,本地缓存提升性能
@@ -36,12 +36,12 @@ @@ -36,12 +36,12 @@
36 * 集成阿里云、腾讯云等短信渠道,集成 MinIO、阿里云、腾讯云、七牛云等云存储服务 36 * 集成阿里云、腾讯云等短信渠道,集成 MinIO、阿里云、腾讯云、七牛云等云存储服务
37 * 集成报表设计器,支持数据报表、图形报表、打印设计等 37 * 集成报表设计器,支持数据报表、图形报表、打印设计等
38 38
39 -| 项目名 | 说明 | 传送门 |  
40 -|--------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------|  
41 -| `ruoyi-vue-pro` | Spring Boot 多模块 | **[Gitee](https://gitee.com/zhijiantianya/ruoyi-vue-pro)**     [Github](https://github.com/YunaiV/ruoyi-vue-pro) |  
42 -| `yudao-cloud` | Spring Cloud 微服务 | **[Gitee](https://gitee.com/zhijiantianya/yudao-cloud)**     [Github](https://github.com/YunaiV/yudao-cloud) |  
43 -| `Spring-Boot-Labs` | Spring Boot & Cloud 入门 | **[Gitee](https://gitee.com/zhijiantianya/SpringBoot-Labs)**     [Github](https://github.com/YunaiV/SpringBoot-Labs) |  
44 - | `ruoyi-vue-pro-mini` | 精简版 移除工作流 支付等模块| **[Gitee](https://gitee.com/zhijiantianya/ruoyi-vue-pro/tree/mini)** | 39 +| 项目名 | 说明 | 传送门 |
  40 +|----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
  41 +| `ruoyi-vue-pro` | Spring Boot 多模块 | **[Gitee](https://gitee.com/zhijiantianya/ruoyi-vue-pro)**     [Github](https://github.com/YunaiV/ruoyi-vue-pro) |
  42 +| `yudao-cloud` | Spring Cloud 微服务 | **[Gitee](https://gitee.com/zhijiantianya/yudao-cloud)**     [Github](https://github.com/YunaiV/yudao-cloud) |
  43 +| `Spring-Boot-Labs` | Spring Boot & Cloud 入门 | **[Gitee](https://gitee.com/zhijiantianya/SpringBoot-Labs)**     [Github](https://github.com/YunaiV/SpringBoot-Labs) |
  44 + | `ruoyi-vue-pro-mini` | 精简版:移除工作流、支付等模块 | **[Gitee](https://gitee.com/zhijiantianya/ruoyi-vue-pro/tree/mini)** |
45 45
46 ## 😎 开源协议 46 ## 😎 开源协议
47 47
@@ -94,8 +94,9 @@ @@ -94,8 +94,9 @@
94 | ⭐️ | 登录日志 | 系统登录日志记录查询,包含登录异常 | 94 | ⭐️ | 登录日志 | 系统登录日志记录查询,包含登录异常 |
95 | 🚀 | 错误码管理 | 系统所有错误码的管理,可在线修改错误提示,无需重启服务 | 95 | 🚀 | 错误码管理 | 系统所有错误码的管理,可在线修改错误提示,无需重启服务 |
96 | | 通知公告 | 系统通知公告信息发布维护 | 96 | | 通知公告 | 系统通知公告信息发布维护 |
97 -| 🚀 | 敏感词 | 配置系统敏感词,支持标签分组 | 97 +| 🚀 | 敏感词 | 配置系统敏感词,支持标签分组 |
98 | 🚀 | 应用管理 | 管理 SSO 单点登录的应用,支持多种 OAuth2 授权方式 | 98 | 🚀 | 应用管理 | 管理 SSO 单点登录的应用,支持多种 OAuth2 授权方式 |
  99 +| 🚀 | 地区管理 | 展示省份、城市、区镇等城市信息,支持 IP 对应城市 |
99 100
100 ### 工作流程 101 ### 工作流程
101 102
@@ -130,7 +131,7 @@ ps:核心功能已经实现,正在对接微信小程序中... @@ -130,7 +131,7 @@ ps:核心功能已经实现,正在对接微信小程序中...
130 | | 表单构建 | 拖动表单元素生成相应的 HTML 代码,支持导出 JSON、Vue 文件 | 131 | | 表单构建 | 拖动表单元素生成相应的 HTML 代码,支持导出 JSON、Vue 文件 |
131 | 🚀 | 配置管理 | 对系统动态配置常用参数,支持 SpringBoot 加载 | 132 | 🚀 | 配置管理 | 对系统动态配置常用参数,支持 SpringBoot 加载 |
132 | ⭐️ | 定时任务 | 在线(添加、修改、删除)任务调度包含执行结果日志 | 133 | ⭐️ | 定时任务 | 在线(添加、修改、删除)任务调度包含执行结果日志 |
133 -| 🚀 | 文件服务 | 支持将文件存储到 S3(MinIO、阿里云、腾讯云、七牛云)、本地、FTP、数据库等 | 134 +| 🚀 | 文件服务 | 支持将文件存储到 S3(MinIO、阿里云、腾讯云、七牛云)、本地、FTP、数据库等 |
134 | 🚀 | API 日志 | 包括 RESTful API 访问日志、异常日志两部分,方便排查 API 相关的问题 | 135 | 🚀 | API 日志 | 包括 RESTful API 访问日志、异常日志两部分,方便排查 API 相关的问题 |
135 | | MySQL 监控 | 监视当前系统数据库连接池状态,可进行分析SQL找出系统性能瓶颈 | 136 | | MySQL 监控 | 监视当前系统数据库连接池状态,可进行分析SQL找出系统性能瓶颈 |
136 | | Redis 监控 | 监控 Redis 数据库的使用情况,使用的 Redis Key 管理 | 137 | | Redis 监控 | 监控 Redis 数据库的使用情况,使用的 Redis Key 管理 |
@@ -167,46 +168,47 @@ ps:核心功能已经实现,正在对接微信小程序中... @@ -167,46 +168,47 @@ ps:核心功能已经实现,正在对接微信小程序中...
167 168
168 ## 🐨 技术栈 169 ## 🐨 技术栈
169 170
170 -| 项目 | 说明 |  
171 -|-------------------------|-----------------------|  
172 -| `yudao-dependencies` | Maven 依赖版本管理 |  
173 -| `yudao-framework` | Java 框架拓展 |  
174 -| `yudao-server` | 管理后台 + 用户 APP 的服务端 |  
175 -| `yudao-ui-admin` | 管理后台的 Vue2 前端项目 |  
176 -| `yudao-ui-admin-vue3` | 管理后台的 Vue3 前端项目 |  
177 -| `yudao-ui-admin-uniapp` | 管理后台的 uni-app 多端项目 |  
178 -| `yudao-ui-app` | 用户 APP 的 UI 界面 |  
179 -| `yudao-module-system` | 系统功能的 Module 模块 |  
180 -| `yudao-module-member` | 会员中心的 Module 模块 |  
181 -| `yudao-module-infra` | 基础设施的 Module 模块 |  
182 -| `yudao-module-bpm` | 工作流程的 Module 模块 |  
183 -| `yudao-module-pay` | 支付系统的 Module 模块 | 171 +| 项目 | 说明 |
  172 +|------------------------------|--------------------|
  173 +| `yudao-dependencies` | Maven 依赖版本管理 |
  174 +| `yudao-framework` | Java 框架拓展 |
  175 +| `yudao-server` | 管理后台 + 用户 APP 的服务端 |
  176 +| `yudao-ui-admin` | 管理后台的 Vue2 前端项目 |
  177 +| `yudao-ui-admin-vue3` | 管理后台的 Vue3 前端项目 |
  178 +| `yudao-ui-admin-uniapp` | 管理后台的 uni-app 多端项目 |
  179 +| `yudao-ui-app` | 用户 APP 的 UI 界面 |
  180 +| `yudao-module-system` | 系统功能的 Module 模块 |
  181 +| `yudao-module-member` | 会员中心的 Module 模块 |
  182 +| `yudao-module-infra` | 基础设施的 Module 模块 |
  183 +| `yudao-module-bpm` | 工作流程的 Module 模块 |
  184 +| `yudao-module-pay` | 支付系统的 Module 模块 |
  185 +| `yudao-module-visualization` | 大屏报表 Module 模块 |
184 186
185 ### 后端 187 ### 后端
186 188
187 -| 框架 | 说明 | 版本 | 学习指南 |  
188 -|---------------------------------------------------------------------------------------------|-----------------------|-------------|----------------------------------------------------------------|  
189 -| [Spring Boot](https://spring.io/projects/spring-boot) | 应用开发框架 | 2.7.6 | [文档](https://github.com/YunaiV/SpringBoot-Labs) |  
190 -| [MySQL](https://www.mysql.com/cn/) | 数据库服务器 | 5.7 / 8.0+ | |  
191 -| [Druid](https://github.com/alibaba/druid) | JDBC 连接池、监控组件 | 1.2.15 | [文档](http://www.iocoder.cn/Spring-Boot/datasource-pool/?yudao) |  
192 -| [MyBatis Plus](https://mp.baomidou.com/) | MyBatis 增强工具包 | 3.5.2 | [文档](http://www.iocoder.cn/Spring-Boot/MyBatis/?yudao) |  
193 -| [Dynamic Datasource](https://dynamic-datasource.com/) | 动态数据源 | 3.6.0 | [文档](http://www.iocoder.cn/Spring-Boot/datasource-pool/?yudao) |  
194 -| [Redis](https://redis.io/) | key-value 数据库 | 5.0 / 6.0 | |  
195 -| [Redisson](https://github.com/redisson/redisson) | Redis 客户端 | 3.18.0 | [文档](http://www.iocoder.cn/Spring-Boot/Redis/?yudao) |  
196 -| [Spring MVC](https://github.com/spring-projects/spring-framework/tree/master/spring-webmvc) | MVC 框架 | 5.3.24 | [文档](http://www.iocoder.cn/SpringMVC/MVC/?yudao) |  
197 -| [Spring Security](https://github.com/spring-projects/spring-security) | Spring 安全框架 | 5.7.5 | [文档](http://www.iocoder.cn/Spring-Boot/Spring-Security/?yudao) |  
198 -| [Hibernate Validator](https://github.com/hibernate/hibernate-validator) | 参数校验组件 | 6.2.5 | [文档](http://www.iocoder.cn/Spring-Boot/Validation/?yudao) |  
199 -| [Flowable](https://github.com/flowable/flowable-engine) | 工作流引擎 | 6.7.2 | [文档](https://doc.iocoder.cn/bpm/) |  
200 -| [Quartz](https://github.com/quartz-scheduler) | 任务调度组件 | 2.3.2 | [文档](http://www.iocoder.cn/Spring-Boot/Job/?yudao) |  
201 -| [Knife4j](https://gitee.com/xiaoym/knife4j) | Swagger 增强 UI 实现 | 3.0.3 | [文档](http://www.iocoder.cn/Spring-Boot/Swagger/?yudao) |  
202 -| [Resilience4j](https://github.com/resilience4j/resilience4j) | 服务保障组件 | 1.7.1 | [文档](http://www.iocoder.cn/Spring-Boot/Resilience4j/?yudao) | 189 +| 框架 | 说明 | 版本 | 学习指南 |
  190 +|---------------------------------------------------------------------------------------------|------------------|-------------|----------------------------------------------------------------|
  191 +| [Spring Boot](https://spring.io/projects/spring-boot) | 应用开发框架 | 2.7.6 | [文档](https://github.com/YunaiV/SpringBoot-Labs) |
  192 +| [MySQL](https://www.mysql.com/cn/) | 数据库服务器 | 5.7 / 8.0+ | |
  193 +| [Druid](https://github.com/alibaba/druid) | JDBC 连接池、监控组件 | 1.2.15 | [文档](http://www.iocoder.cn/Spring-Boot/datasource-pool/?yudao) |
  194 +| [MyBatis Plus](https://mp.baomidou.com/) | MyBatis 增强工具包 | 3.5.2 | [文档](http://www.iocoder.cn/Spring-Boot/MyBatis/?yudao) |
  195 +| [Dynamic Datasource](https://dynamic-datasource.com/) | 动态数据源 | 3.6.0 | [文档](http://www.iocoder.cn/Spring-Boot/datasource-pool/?yudao) |
  196 +| [Redis](https://redis.io/) | key-value 数据库 | 5.0 / 6.0 | |
  197 +| [Redisson](https://github.com/redisson/redisson) | Redis 客户端 | 3.18.0 | [文档](http://www.iocoder.cn/Spring-Boot/Redis/?yudao) |
  198 +| [Spring MVC](https://github.com/spring-projects/spring-framework/tree/master/spring-webmvc) | MVC 框架 | 5.3.24 | [文档](http://www.iocoder.cn/SpringMVC/MVC/?yudao) |
  199 +| [Spring Security](https://github.com/spring-projects/spring-security) | Spring 安全框架 | 5.7.5 | [文档](http://www.iocoder.cn/Spring-Boot/Spring-Security/?yudao) |
  200 +| [Hibernate Validator](https://github.com/hibernate/hibernate-validator) | 参数校验组件 | 6.2.5 | [文档](http://www.iocoder.cn/Spring-Boot/Validation/?yudao) |
  201 +| [Flowable](https://github.com/flowable/flowable-engine) | 工作流引擎 | 6.7.2 | [文档](https://doc.iocoder.cn/bpm/) |
  202 +| [Quartz](https://github.com/quartz-scheduler) | 任务调度组件 | 2.3.2 | [文档](http://www.iocoder.cn/Spring-Boot/Job/?yudao) |
  203 +| [Knife4j](https://gitee.com/xiaoym/knife4j) | Swagger 增强 UI 实现 | 3.0.3 | [文档](http://www.iocoder.cn/Spring-Boot/Swagger/?yudao) |
  204 +| [Resilience4j](https://github.com/resilience4j/resilience4j) | 服务保障组件 | 1.7.1 | [文档](http://www.iocoder.cn/Spring-Boot/Resilience4j/?yudao) |
203 | [SkyWalking](https://skywalking.apache.org/) | 分布式应用追踪系统 | 8.12.0 | [文档](http://www.iocoder.cn/Spring-Boot/SkyWalking/?yudao) | 205 | [SkyWalking](https://skywalking.apache.org/) | 分布式应用追踪系统 | 8.12.0 | [文档](http://www.iocoder.cn/Spring-Boot/SkyWalking/?yudao) |
204 -| [Spring Boot Admin](https://github.com/codecentric/spring-boot-admin) | Spring Boot 监控平台 | 2.7.9 | [文档](http://www.iocoder.cn/Spring-Boot/Admin/?yudao) |  
205 -| [Jackson](https://github.com/FasterXML/jackson) | JSON 工具库 | 2.13.3 | |  
206 -| [MapStruct](https://mapstruct.org/) | Java Bean 转换 | 1.5.3.Final | [文档](http://www.iocoder.cn/Spring-Boot/MapStruct/?yudao) |  
207 -| [Lombok](https://projectlombok.org/) | 消除冗长的 Java 代码 | 1.18.24 | [文档](http://www.iocoder.cn/Spring-Boot/Lombok/?yudao) |  
208 -| [JUnit](https://junit.org/junit5/) | Java 单元测试框架 | 5.8.2 | - |  
209 -| [Mockito](https://github.com/mockito/mockito) | Java Mock 框架 | 4.8.0 | - | 206 +| [Spring Boot Admin](https://github.com/codecentric/spring-boot-admin) | Spring Boot 监控平台 | 2.7.9 | [文档](http://www.iocoder.cn/Spring-Boot/Admin/?yudao) |
  207 +| [Jackson](https://github.com/FasterXML/jackson) | JSON 工具库 | 2.13.3 | |
  208 +| [MapStruct](https://mapstruct.org/) | Java Bean 转换 | 1.5.3.Final | [文档](http://www.iocoder.cn/Spring-Boot/MapStruct/?yudao) |
  209 +| [Lombok](https://projectlombok.org/) | 消除冗长的 Java 代码 | 1.18.24 | [文档](http://www.iocoder.cn/Spring-Boot/Lombok/?yudao) |
  210 +| [JUnit](https://junit.org/junit5/) | Java 单元测试框架 | 5.8.2 | - |
  211 +| [Mockito](https://github.com/mockito/mockito) | Java Mock 框架 | 4.8.0 | - |
210 212
211 ### [管理后台 Vue2 前端](./yudao-ui-admin) 213 ### [管理后台 Vue2 前端](./yudao-ui-admin)
212 214
@@ -217,22 +219,22 @@ ps:核心功能已经实现,正在对接微信小程序中... @@ -217,22 +219,22 @@ ps:核心功能已经实现,正在对接微信小程序中...
217 219
218 ### [管理后台 Vue3 前端](./yudao-ui-admin-vue3) 220 ### [管理后台 Vue3 前端](./yudao-ui-admin-vue3)
219 221
220 -| 框架 | 说明 | 版本 | 222 +| 框架 | 说明 | 版本 |
221 |----------------------------------------------------------------------|:------------:|:------:| 223 |----------------------------------------------------------------------|:------------:|:------:|
222 -| [Vue](https://staging-cn.vuejs.org/) | Vue 框架 | 3.2.45 |  
223 -| [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 4.0.3 | 224 +| [Vue](https://staging-cn.vuejs.org/) | Vue 框架 | 3.2.45 |
  225 +| [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 4.0.3 |
224 | [Element Plus](https://element-plus.org/zh-CN/) | Element Plus | 2.2.27 | 226 | [Element Plus](https://element-plus.org/zh-CN/) | Element Plus | 2.2.27 |
225 | [TypeScript](https://www.typescriptlang.org/docs/) | TypeScript | 4.9.4 | 227 | [TypeScript](https://www.typescriptlang.org/docs/) | TypeScript | 4.9.4 |
226 | [pinia](https://pinia.vuejs.org/) | vuex5 | 2.0.28 | 228 | [pinia](https://pinia.vuejs.org/) | vuex5 | 2.0.28 |
227 -| [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化 | 9.2.2 |  
228 -| [vxe-table](https://vxetable.cn/) | vue最强表单 | 4.3.7 | 229 +| [vue-i18n](https://kazupon.github.io/vue-i18n/zh/introduction.html/) | 国际化 | 9.2.2 |
  230 +| [vxe-table](https://vxetable.cn/) | vue最强表单 | 4.3.7 |
229 231
230 ### [管理后台 uni-app 跨端](./yudao-ui-admin-uniapp) 232 ### [管理后台 uni-app 跨端](./yudao-ui-admin-uniapp)
231 233
232 -| 框架 | 说明 | 版本 |  
233 -|----------------------------------------------------------------------|------------------|--------|  
234 -| [uni-app](hhttps://github.com/dcloudio/uni-app) | 跨平台框架 | 2.0.0 |  
235 -| [uni-ui](https://github.com/dcloudio/uni-ui) | 基于 uni-app 的 UI 框架 | 1.4.20 | 234 +| 框架 | 说明 | 版本 |
  235 +|-------------------------------------------------|--------------------|--------|
  236 +| [uni-app](hhttps://github.com/dcloudio/uni-app) | 跨平台框架 | 2.0.0 |
  237 +| [uni-ui](https://github.com/dcloudio/uni-ui) | 基于 uni-app 的 UI 框架 | 1.4.20 |
236 238
237 ## 🐷 演示图 239 ## 🐷 演示图
238 240