README:增加说明文案

pull/77/MERGE
YunaiV 2025-04-21 19:43:21 +08:00
parent 3b8cb14bdb
commit fb6539476a
1 changed files with 131 additions and 131 deletions

View File

@ -9,38 +9,38 @@
## 🐶 新手必读 ## 🐶 新手必读
* nodejs > 16.18.0 && pnpm > 8.6.0 (强制使用pnpm) - nodejs > 16.18.0 && pnpm > 8.6.0 (强制使用pnpm)
* 演示地址【Vue3 + element-plus】<http://dashboard-vue3.yudao.iocoder.cn> - 演示地址【Vue3 + element-plus】<http://dashboard-vue3.yudao.iocoder.cn>
* 演示地址【Vue3 + vben5.0(ant-design-vue)】:<http://dashboard-vben.yudao.iocoder.cn> - 演示地址【Vue3 + vben5.0(ant-design-vue)】:<http://dashboard-vben.yudao.iocoder.cn>
* 演示地址【Vue2 + element-ui】<http://dashboard.yudao.iocoder.cn> - 演示地址【Vue2 + element-ui】<http://dashboard.yudao.iocoder.cn>
* 启动文档:<https://doc.iocoder.cn/quick-start/> - 启动文档:<https://doc.iocoder.cn/quick-start/>
* 视频教程:<https://doc.iocoder.cn/video/> - 视频教程:<https://doc.iocoder.cn/video/>
## 🐯 平台简介 ## 🐯 平台简介
**芋道**,以开发者为中心,打造中国第一流的快速开发平台,全部开源,个人与企业可 100% 免费使用。 **芋道**,以开发者为中心,打造中国第一流的快速开发平台,全部开源,个人与企业可 100% 免费使用。
* 采用最新 [vue-vben-admin](https://github.com/vbenjs/vue-vben-admin) v5.0 实现 - 采用最新 [vue-vben-admin](https://github.com/vbenjs/vue-vben-admin) v5.0 实现
* 支持 Ant Design 或 Element Plus 或 Naive UI 多种免费开源的中后台模版,具备如下特性: - 支持 Ant Design 或 Element Plus 或 Naive UI 多种免费开源的中后台模版,具备如下特性:
![首页](./image/demo/vben.png) ![首页](.image/demo/vben.png)
* **最新技术栈**:使用 Vue3、Vite5 等前端前沿技术开发 - **最新技术栈**:使用 Vue3、Vite5 等前端前沿技术开发
* **TypeScript**: 应用程序级 JavaScript 的语言 - **TypeScript**: 应用程序级 JavaScript 的语言
* **主题**: 提供多套主题色彩,可配置自定义主题 - **主题**: 提供多套主题色彩,可配置自定义主题
* **国际化**:内置完善的国际化方案 - **国际化**:内置完善的国际化方案
* **权限**:内置完善的动态路由权限生成方案 - **权限**:内置完善的动态路由权限生成方案
* **组件**:二次封装了多个常用的组件 - **组件**:二次封装了多个常用的组件
* **示例**:内置丰富的示例 - **示例**:内置丰富的示例
## 外包项目请联系【非项目需求请勿扫码,非客服,不解答项目问题】 ## 外包项目请联系【非项目需求请勿扫码,非客服,不解答项目问题】
![alt 定制开发](./image/wx-xingyu.png) ![alt 定制开发](.image/wx-xingyu.png)
## 技术栈 ## 技术栈
| 框架 | 说明 | 版本 | | 框架 | 说明 | 版本 |
|----------------------------------------------------------------------|-----------------|---------| | --- | --- | --- |
| [Vue](https://staging-cn.vuejs.org/) | vue框架 | 3.5.13 | | [Vue](https://staging-cn.vuejs.org/) | vue框架 | 3.5.13 |
| [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 6.2.5 | | [Vite](https://cn.vitejs.dev//) | 开发与构建工具 | 6.2.5 |
| [Ant Design Vue](https://www.antdv.com/) | Ant Design Vue | 4.2.6 | | [Ant Design Vue](https://www.antdv.com/) | Ant Design Vue | 4.2.6 |
@ -80,14 +80,14 @@
![功能分层](/.image/common/ruoyi-vue-pro-biz.png) ![功能分层](/.image/common/ruoyi-vue-pro-biz.png)
* 通用模块(必选):系统功能、基础设施 - 通用模块(必选):系统功能、基础设施
* 通用模块(可选):工作流程、支付系统、数据报表、会员中心 - 通用模块(可选):工作流程、支付系统、数据报表、会员中心
* 业务系统按需ERP 系统、CRM 系统、商城系统、微信公众号、AI 大模型 - 业务系统按需ERP 系统、CRM 系统、商城系统、微信公众号、AI 大模型
### 系统功能 ### 系统功能
| | 功能 | 描述 | | | 功能 | 描述 |
|-----|-------|---------------------------------| | --- | --- | --- |
| | 用户管理 | 用户是系统操作者,该功能主要完成系统用户配置 | | | 用户管理 | 用户是系统操作者,该功能主要完成系统用户配置 |
| ⭐️ | 在线用户 | 当前系统中活跃用户状态监控,支持手动踢下线 | | ⭐️ | 在线用户 | 当前系统中活跃用户状态监控,支持手动踢下线 |
| | 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 | | | 角色管理 | 角色菜单权限分配、设置角色按机构进行数据范围权限划分 |
@ -117,15 +117,15 @@
基于 Flowable 构建,可支持信创(国产)数据库,满足中国特色流程操作: 基于 Flowable 构建,可支持信创(国产)数据库,满足中国特色流程操作:
| BPMN 设计器 | 钉钉/飞书设计器 | | BPMN 设计器 | 钉钉/飞书设计器 |
|------------------------------|--------------------------------| | --------------------------------- | ----------------------------------- |
| ![](/.image/工作流设计器-bpmn.jpg) | ![](/.image/工作流设计器-simple.jpg) | | ![](.image/工作流设计器-bpmn.jpg) | ![](.image/工作流设计器-simple.jpg) |
> 历经头部企业生产验证,工作流引擎须标配仿钉钉/飞书 + BPMN 双设计器!!! > 历经头部企业生产验证,工作流引擎须标配仿钉钉/飞书 + BPMN 双设计器!!!
> >
> 前者支持轻量配置简单流程,后者实现复杂场景深度编排 > 前者支持轻量配置简单流程,后者实现复杂场景深度编排
| 功能列表 | 功能描述 | 是否完成 | | 功能列表 | 功能描述 | 是否完成 |
|------------|-------------------------------------------------------------------------------------|------| | --- | --- | --- |
| SIMPLE 设计器 | 仿钉钉/飞书设计器支持拖拽搭建表单流程10 分钟快速完成审批流程配置 | ✅ | | SIMPLE 设计器 | 仿钉钉/飞书设计器支持拖拽搭建表单流程10 分钟快速完成审批流程配置 | ✅ |
| BPMN 设计器 | 基于 BPMN 标准开发,适配复杂业务场景,满足多层级审批及流程自动化需求 | ✅ | | BPMN 设计器 | 基于 BPMN 标准开发,适配复杂业务场景,满足多层级审批及流程自动化需求 | ✅ |
| 会签 | 同一个审批节点设置多个人(如 A、B、C 三人,三人会同时收到待办任务),需全部同意之后,审批才可到下一审批节点 | ✅ | | 会签 | 同一个审批节点设置多个人(如 A、B、C 三人,三人会同时收到待办任务),需全部同意之后,审批才可到下一审批节点 | ✅ |
@ -154,7 +154,7 @@
### 支付系统 ### 支付系统
| | 功能 | 描述 | | | 功能 | 描述 |
|-----|------|---------------------------| | --- | -------- | -------------------------------------------------- |
| 🚀 | 应用信息 | 配置商户的应用信息,对接支付宝、微信等多个支付渠道 | | 🚀 | 应用信息 | 配置商户的应用信息,对接支付宝、微信等多个支付渠道 |
| 🚀 | 支付订单 | 查看用户发起的支付宝、微信等的【支付】订单 | | 🚀 | 支付订单 | 查看用户发起的支付宝、微信等的【支付】订单 |
| 🚀 | 退款订单 | 查看用户发起的支付宝、微信等的【退款】订单 | | 🚀 | 退款订单 | 查看用户发起的支付宝、微信等的【退款】订单 |
@ -164,7 +164,7 @@
### 基础设施 ### 基础设施
| | 功能 | 描述 | | | 功能 | 描述 |
|-----|-----------|----------------------------------------------| | --- | --- | --- |
| 🚀 | 代码生成 | 前后端代码的生成Java、Vue、SQL、单元测试支持 CRUD 下载 | | 🚀 | 代码生成 | 前后端代码的生成Java、Vue、SQL、单元测试支持 CRUD 下载 |
| 🚀 | 系统接口 | 基于 Swagger 自动生成相关的 RESTful API 接口文档 | | 🚀 | 系统接口 | 基于 Swagger 自动生成相关的 RESTful API 接口文档 |
| 🚀 | 数据库文档 | 基于 Screw 自动生成数据库文档,支持导出 Word、HTML、MD 格式 | | 🚀 | 数据库文档 | 基于 Screw 自动生成数据库文档,支持导出 Word、HTML、MD 格式 |
@ -189,14 +189,14 @@
### 数据报表 ### 数据报表
| | 功能 | 描述 | | | 功能 | 描述 |
|-----|-------|--------------------| | --- | ---------- | ------------------------------------ |
| 🚀 | 报表设计器 | 支持数据报表、图形报表、打印设计等 | | 🚀 | 报表设计器 | 支持数据报表、图形报表、打印设计等 |
| 🚀 | 大屏设计器 | 拖拽生成数据大屏,内置几十种图表组件 | | 🚀 | 大屏设计器 | 拖拽生成数据大屏,内置几十种图表组件 |
### 微信公众号 ### 微信公众号
| | 功能 | 描述 | | | 功能 | 描述 |
|-----|--------|-------------------------------| | --- | --- | --- |
| 🚀 | 账号管理 | 配置接入的微信公众号,可支持多个公众号 | | 🚀 | 账号管理 | 配置接入的微信公众号,可支持多个公众号 |
| 🚀 | 数据统计 | 统计公众号的用户增减、累计用户、消息概况、接口分析等数据 | | 🚀 | 数据统计 | 统计公众号的用户增减、累计用户、消息概况、接口分析等数据 |
| 🚀 | 粉丝管理 | 查看已关注、取关的粉丝列表,可对粉丝进行同步、打标签等操作 | | 🚀 | 粉丝管理 | 查看已关注、取关的粉丝列表,可对粉丝进行同步、打标签等操作 |