From 703b3e1cc6ee9a14c57c254dfce9c6fee402c86a Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Wed, 16 Jul 2025 07:09:33 +0000 Subject: [PATCH] Update README.md with new sections, table of contents, and image paths Co-authored-by: dingjiangying --- README.md | 100 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 57 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index 62252f9ac3..035c0675b9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# 芋道快速开发平台 +

Downloads Downloads @@ -13,6 +15,18 @@ 如果这个项目让你有所收获，记得 Star 关注哦，这对我是非常不错的鼓励与支持。 +## 目录 + +* [新手必读](#-新手必读) +* [版本说明](#-版本说明) +* [平台简介](#-平台简介) +* [项目关系](#-项目关系) +* [内置功能](#-内置功能) +* [技术栈](#-技术栈) +* [演示图](#-演示图) +* [开源协议](#-开源协议) +* [项目外包](#-项目外包) + ## 🐶 新手必读 * 演示地址【Vue3 + element-plus】： @@ -41,7 +55,7 @@ > > 😜 给项目点点 Star 吧，这对我们真的很重要！ -![架构图](/.image/common/ruoyi-vue-pro-architecture.png) +![架构图](./.image/common/ruoyi-vue-pro-architecture.png) * Java 后端：`master` 分支为 JDK 8 + Spring Boot 2.7，`master-jdk17` 分支为 JDK 17/21 + Spring Boot 3.2 * 管理后台的电脑端：Vue3 提供 `element-plus`、`vben(ant-design-vue)` 两个版本，Vue2 提供 `element-ui` 版本 @@ -61,7 +75,7 @@ ## 🐳 项目关系 -![架构演进](/.image/common/yudao-roadmap.png) +![架构演进](./.image/common/yudao-roadmap.png) 三个项目的功能对比，可见社区共同整理的 [国产开源项目对比](https://www.yuque.com/xiatian-bsgny/lm0ec1/wqf8mn) 表格。 @@ -71,7 +85,7 @@ |-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| | [ruoyi-vue-pro](https://gitee.com/zhijiantianya/ruoyi-vue-pro) | [![Gitee star](https://gitee.com/zhijiantianya/ruoyi-vue-pro/badge/star.svg?theme=white)](https://gitee.com/zhijiantianya/ruoyi-vue-pro) [![GitHub stars](https://img.shields.io/github/stars/YunaiV/ruoyi-vue-pro.svg?style=social&label=Stars)](https://github.com/YunaiV/ruoyi-vue-pro) | 基于 Spring Boot 多模块架构 | | [yudao-cloud](https://gitee.com/zhijiantianya/yudao-cloud) | [![Gitee star](https://gitee.com/zhijiantianya/yudao-cloud/badge/star.svg?theme=white)](https://gitee.com/zhijiantianya/yudao-cloud) [![GitHub stars](https://img.shields.io/github/stars/YunaiV/yudao-cloud.svg?style=social&label=Stars)](https://github.com/YunaiV/yudao-cloud) | 基于 Spring Cloud 微服务架构 | -| [Spring-Boot-Labs](https://gitee.com/yudaocode/SpringBoot-Labs) | [![Gitee star](https://gitee.com/yudaocode/SpringBoot-Labs/badge/star.svg?theme=white)](https://gitee.com/zhijiantianya/yudao-cloud) [![GitHub stars](https://img.shields.io/github/stars/yudaocode/SpringBoot-Labs.svg?style=social&label=Stars)](https://github.com/yudaocode/SpringBoot-Labs) | 系统学习 Spring Boot & Cloud 专栏 | +| [Spring-Boot-Labs](https://gitee.com/yudaocode/SpringBoot-Labs) | [![Gitee star](https://gitee.com/zhijiantianya/yudao-cloud/badge/star.svg?theme=white)](https://gitee.com/zhijiantianya/yudao-cloud) [![GitHub stars](https://img.shields.io/github/stars/yudaocode/SpringBoot-Labs.svg?style=social&label=Stars)](https://github.com/yudaocode/SpringBoot-Labs) | 系统学习 Spring Boot & Cloud 专栏 | ### 前端项目 @@ -92,7 +106,7 @@ ② 代码全部开源，不会像其他项目一样，只开源部分代码，让你无法了解整个项目的架构设计。[国产开源项目对比](https://www.yuque.com/xiatian-bsgny/lm0ec1/wqf8mn) -![开源项目对比](/.image/common/project-vs.png) +![开源项目对比](./.image/common/project-vs.png) ③ 代码整洁、架构整洁，遵循《阿里巴巴 Java 开发手册》规范，代码注释详细，113770 行 Java 代码，42462 行代码注释。 @@ -108,7 +122,7 @@ 系统内置多种多种业务功能，可以用于快速你的业务系统： -![功能分层](/.image/common/ruoyi-vue-pro-biz.png) +![功能分层](./.image/common/ruoyi-vue-pro-biz.png) * 通用模块（必选）：系统功能、基础设施 * 通用模块（可选）：工作流程、支付系统、数据报表、会员中心 @@ -145,17 +159,17 @@ | 🚀 | 应用管理 | 管理 SSO 单点登录的应用，支持多种 OAuth2 授权方式 | | 🚀 | 地区管理 | 展示省份、城市、区镇等城市信息，支持 IP 对应城市 | -![功能图](/.image/common/system-feature.png) +![功能图](./.image/common/system-feature.png) ### 工作流程 -![功能图](/.image/common/bpm-feature.png) +![功能图](./.image/common/bpm-feature.png) 基于 Flowable 构建，可支持信创（国产）数据库，满足中国特色流程操作： | BPMN 设计器 | 钉钉/飞书设计器 | |------------------------------|--------------------------------| -| ![](/.image/工作流设计器-bpmn.jpg) | ![](/.image/工作流设计器-simple.jpg) | +| ![](./.image/工作流设计器-bpmn.jpg) | ![](./.image/工作流设计器-simple.jpg) | > 历经头部企业生产验证，工作流引擎须标配仿钉钉/飞书 + BPMN 双设计器！！！ > @@ -221,7 +235,7 @@ | 🚀 | 日志服务 | 轻量级日志中心，查看远程服务器的日志 | | 🚀 | 单元测试 | 基于 JUnit + Mockito 实现单元测试，保证功能的正确性、代码的质量等 | -![功能图](/.image/common/infra-feature.png) +![功能图](./.image/common/infra-feature.png) ### 数据报表 @@ -249,9 +263,9 @@ 演示地址： -![功能图](/.image/common/mall-feature.png) +![功能图](./.image/common/mall-feature.png) -![功能图](/.image/common/mall-preview.png) +![功能图](./.image/common/mall-preview.png) ### 会员中心 @@ -267,21 +281,21 @@ 演示地址： -![功能图](/.image/common/erp-feature.png) +![功能图](./.image/common/erp-feature.png) ### CRM 系统 演示地址： -![功能图](/.image/common/crm-feature.png) +![功能图](./.image/common/crm-feature.png) ### AI 大模型 演示地址： -![功能图](/.image/common/ai-feature.png) +![功能图](./.image/common/ai-feature.png) -![功能图](/.image/common/ai-preview.gif) +![功能图](./.image/common/ai-preview.gif) ## 🐨 技术栈 @@ -335,57 +349,57 @@ | 模块 | biu | biu | biu | |----------|-----------------------------|---------------------------|--------------------------| -| 登录 & 首页 | ![登录](/.image/登录.jpg) | ![首页](/.image/首页.jpg) | ![个人中心](/.image/个人中心.jpg) | -| 用户 & 应用 | ![用户管理](/.image/用户管理.jpg) | ![令牌管理](/.image/令牌管理.jpg) | ![应用管理](/.image/应用管理.jpg) | -| 租户 & 套餐 | ![租户管理](/.image/租户管理.jpg) | ![租户套餐](/.image/租户套餐.png) | - | -| 部门 & 岗位 | ![部门管理](/.image/部门管理.jpg) | ![岗位管理](/.image/岗位管理.jpg) | - | -| 菜单 & 角色 | ![菜单管理](/.image/菜单管理.jpg) | ![角色管理](/.image/角色管理.jpg) | - | -| 审计日志 | ![操作日志](/.image/操作日志.jpg) | ![登录日志](/.image/登录日志.jpg) | - | -| 短信 | ![短信渠道](/.image/短信渠道.jpg) | ![短信模板](/.image/短信模板.jpg) | ![短信日志](/.image/短信日志.jpg) | -| 字典 & 敏感词 | ![字典类型](/.image/字典类型.jpg) | ![字典数据](/.image/字典数据.jpg) | ![敏感词](/.image/敏感词.jpg) | -| 错误码 & 通知 | ![错误码管理](/.image/错误码管理.jpg) | ![通知公告](/.image/通知公告.jpg) | - | +| 登录 & 首页 | ![登录](./.image/登录.jpg) | ![首页](./.image/首页.jpg) | ![个人中心](./.image/个人中心.jpg) | +| 用户 & 应用 | ![用户管理](./.image/用户管理.jpg) | ![令牌管理](./.image/令牌管理.jpg) | ![应用管理](./.image/应用管理.jpg) | +| 租户 & 套餐 | ![租户管理](./.image/租户管理.jpg) | ![租户套餐](./.image/租户套餐.png) | - | +| 部门 & 岗位 | ![部门管理](./.image/部门管理.jpg) | ![岗位管理](./.image/岗位管理.jpg) | - | +| 菜单 & 角色 | ![菜单管理](./.image/菜单管理.jpg) | ![角色管理](./.image/角色管理.jpg) | - | +| 审计日志 | ![操作日志](./.image/操作日志.jpg) | ![登录日志](./.image/登录日志.jpg) | - | +| 短信 | ![短信渠道](./.image/短信渠道.jpg) | ![短信模板](./.image/短信模板.jpg) | ![短信日志](./.image/短信日志.jpg) | +| 字典 & 敏感词 | ![字典类型](./.image/字典类型.jpg) | ![字典数据](./.image/字典数据.jpg) | ![敏感词](./.image/敏感词.jpg) | +| 错误码 & 通知 | ![错误码管理](./.image/错误码管理.jpg) | ![通知公告](./.image/通知公告.jpg) | - | ### 工作流程 | 模块 | biu | biu | biu | |---------|---------------------------------|---------------------------------|---------------------------------| -| 流程模型 | ![流程模型-列表](/.image/流程模型-列表.jpg) | ![流程模型-设计](/.image/流程模型-设计.jpg) | ![流程模型-定义](/.image/流程模型-定义.jpg) | -| 表单 & 分组 | ![流程表单](/.image/流程表单.jpg) | ![用户分组](/.image/用户分组.jpg) | - | -| 我的流程 | ![我的流程-列表](/.image/我的流程-列表.jpg) | ![我的流程-发起](/.image/我的流程-发起.jpg) | ![我的流程-详情](/.image/我的流程-详情.jpg) | -| 待办 & 已办 | ![任务列表-审批](/.image/任务列表-审批.jpg) | ![任务列表-待办](/.image/任务列表-待办.jpg) | ![任务列表-已办](/.image/任务列表-已办.jpg) | -| OA 请假 | ![OA请假-列表](/.image/OA请假-列表.jpg) | ![OA请假-发起](/.image/OA请假-发起.jpg) | ![OA请假-详情](/.image/OA请假-详情.jpg) | +| 流程模型 | ![流程模型-列表](./.image/流程模型-列表.jpg) | ![流程模型-设计](./.image/流程模型-设计.jpg) | ![流程模型-定义](./.image/流程模型-定义.jpg) | +| 表单 & 分组 | ![流程表单](./.image/流程表单.jpg) | ![用户分组](./.image/用户分组.jpg) | - | +| 我的流程 | ![我的流程-列表](./.image/我的流程-列表.jpg) | ![我的流程-发起](./.image/我的流程-发起.jpg) | ![我的流程-详情](./.image/我的流程-详情.jpg) | +| 待办 & 已办 | ![任务列表-审批](./.image/任务列表-审批.jpg) | ![任务列表-待办](./.image/任务列表-待办.jpg) | ![任务列表-已办](./.image/任务列表-已办.jpg) | +| OA 请假 | ![OA请假-列表](./.image/OA请假-列表.jpg) | ![OA请假-发起](./.image/OA请假-发起.jpg) | ![OA请假-详情](./.image/OA请假-详情.jpg) | ### 基础设施 | 模块 | biu | biu | biu | |---------------|-------------------------------|-----------------------------|---------------------------| -| 代码生成 | ![代码生成](/.image/代码生成.jpg) | ![生成效果](/.image/生成效果.jpg) | - | -| 文档 | ![系统接口](/.image/系统接口.jpg) | ![数据库文档](/.image/数据库文档.jpg) | - | -| 文件 & 配置 | ![文件配置](/.image/文件配置.jpg) | ![文件管理](/.image/文件管理2.jpg) | ![配置管理](/.image/配置管理.jpg) | -| 定时任务 | ![定时任务](/.image/定时任务.jpg) | ![任务日志](/.image/任务日志.jpg) | - | -| API 日志 | ![访问日志](/.image/访问日志.jpg) | ![错误日志](/.image/错误日志.jpg) | - | -| MySQL & Redis | ![MySQL](/.image/MySQL.jpg) | ![Redis](/.image/Redis.jpg) | - | -| 监控平台 | ![Java监控](/.image/Java监控.jpg) | ![链路追踪](/.image/链路追踪.jpg) | ![日志中心](/.image/日志中心.jpg) | +| 代码生成 | ![代码生成](./.image/代码生成.jpg) | ![生成效果](./.image/生成效果.jpg) | - | +| 文档 | ![系统接口](./.image/系统接口.jpg) | ![数据库文档](./.image/数据库文档.jpg) | - | +| 文件 & 配置 | ![文件配置](./.image/文件配置.jpg) | ![文件管理](./.image/文件管理2.jpg) | ![配置管理](./.image/配置管理.jpg) | +| 定时任务 | ![定时任务](./.image/定时任务.jpg) | ![任务日志](./.image/任务日志.jpg) | - | +| API 日志 | ![访问日志](./.image/访问日志.jpg) | ![错误日志](./.image/错误日志.jpg) | - | +| MySQL & Redis | ![MySQL](./.image/MySQL.jpg) | ![Redis](./.image/Redis.jpg) | - | +| 监控平台 | ![Java监控](./.image/Java监控.jpg) | ![链路追踪](./.image/链路追踪.jpg) | ![日志中心](./.image/日志中心.jpg) | ### 支付系统 | 模块 | biu | biu | biu | |---------|---------------------------|---------------------------------|---------------------------------| -| 商家 & 应用 | ![商户信息](/.image/商户信息.jpg) | ![应用信息-列表](/.image/应用信息-列表.jpg) | ![应用信息-编辑](/.image/应用信息-编辑.jpg) | -| 支付 & 退款 | ![支付订单](/.image/支付订单.jpg) | ![退款订单](/.image/退款订单.jpg) | --- | +| 商家 & 应用 | ![商户信息](./.image/商户信息.jpg) | ![应用信息-列表](./.image/应用信息-列表.jpg) | ![应用信息-编辑](./.image/应用信息-编辑.jpg) | +| 支付 & 退款 | ![支付订单](./.image/支付订单.jpg) | ![退款订单](./.image/退款订单.jpg) | --- | ### 数据报表 | 模块 | biu | biu | biu | |-------|---------------------------------|---------------------------------|---------------------------------------| -| 报表设计器 | ![数据报表](/.image/报表设计器-数据报表.jpg) | ![图形报表](/.image/报表设计器-图形报表.jpg) | ![报表设计器-打印设计](/.image/报表设计器-打印设计.jpg) | -| 大屏设计器 | ![大屏列表](/.image/大屏设计器-列表.jpg) | ![大屏预览](/.image/大屏设计器-预览.jpg) | ![大屏编辑](/.image/大屏设计器-编辑.jpg) | +| 报表设计器 | ![数据报表](./.image/报表设计器-数据报表.jpg) | ![图形报表](./.image/报表设计器-图形报表.jpg) | ![报表设计器-打印设计](./.image/报表设计器-打印设计.jpg) | +| 大屏设计器 | ![大屏列表](./.image/大屏设计器-列表.jpg) | ![大屏预览](./.image/大屏设计器-预览.jpg) | ![大屏编辑](./.image/大屏设计器-编辑.jpg) | ### 移动端（管理后台） | biu | biu | biu | |----------------------------------|----------------------------------|----------------------------------| -| ![](/.image/admin-uniapp/01.png) | ![](/.image/admin-uniapp/02.png) | ![](/.image/admin-uniapp/03.png) | -| ![](/.image/admin-uniapp/04.png) | ![](/.image/admin-uniapp/05.png) | ![](/.image/admin-uniapp/06.png) | -| ![](/.image/admin-uniapp/07.png) | ![](/.image/admin-uniapp/08.png) | ![](/.image/admin-uniapp/09.png) | +| ![](./.image/admin-uniapp/01.png) | ![](./.image/admin-uniapp/02.png) | ![](./.image/admin-uniapp/03.png) | +| ![](./.image/admin-uniapp/04.png) | ![](./.image/admin-uniapp/05.png) | ![](./.image/admin-uniapp/06.png) | +| ![](./.image/admin-uniapp/07.png) | ![](./.image/admin-uniapp/08.png) | ![](./.image/admin-uniapp/09.png) | 目前已经实现登录、我的、工作台、编辑资料、头像修改、密码修改、常见问题、关于我们等基础功能。