docs(readme): 更新项目文档

This commit is contained in:
dubai
2026-01-11 14:02:38 +08:00
parent eaf5c01a33
commit bd51228293

View File

@@ -1,8 +1,10 @@
## **简介**
基于 [ruoyi-plus-vben & vben5 & ant-design-vue ](https://gitee.com/dapppp/ruoyi-plus-vben.git) 的 前端项目
[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE)
**完全兼容意框架[Yi.Admin](https://gitee.com/ccnetcore/Yi) rbac模块**
基于 [ruoyi-plus-vben & vben5 & ant-design-vue ](https://gitee.com/dapppp/ruoyi-plus-vben.git) 的 Yi 框架前端项目
完全兼容意框架[Yi.Admin](https://gitee.com/ccnetcore/Yi) rbac模块
| 组件/框架 | 版本 |
| :------------- | :----- |
@@ -10,36 +12,22 @@
| ant-design-vue | 4.2.6 |
| vue | 3.5.13 |
[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE)
## 提示
该仓库使用vben最新版本v5开发
v5版本采用分仓(包)目录结构, 具体开发路径为: `根目录/apps/web-antd`
该仓库使用vben5开发,采用分包目录结构, 具体开发路径为: `根目录/apps/web-antd`
**后端需要开启”furion格式的规范化api“**路径在Yi.Abp.Net8/src/Yi.Abp.Web/YiAbpWebModule.cs
## 预览
[预览地址点这里](https://yi.wjys.top/)
## 文档
[ruoyi-plus-vben 框架文档](https://dapdap.top/)
[ruoyi-vben 框架文档](https://dapdap.top/)
[Vben V5 文档地址](https://doc.vben.pro/)
[后端 Yi 框架 文档地址](https://gitee.com/ccnetcore/Yi)
## 🚀系统截图
![image-20260101175759249](/resource/image-20260101175759249.png)
![image-20260101175912025](/resource/image-20260101175912025.png)
![image-20260101180006771](/resource/image-20260101180006771.png)
[VbenAdmin V5 文档地址](https://doc.vben.pro/)
## 安装使用
@@ -54,13 +42,7 @@ v5版本采用分仓(包)目录结构, 具体开发路径为: `根目录/apps/we
},
```
- 获取项目代码
```bash
git clone -b only-front --single-branch https://gitee.com/vichen2021/yiabp-mini.git
```
2. 安装依赖
安装依赖
```bash
cd yiabp-mini
@@ -68,24 +50,13 @@ cd yiabp-mini
pnpm install
```
- 菜单图标替换
参考 [菜单图标替换](https://dapdap.top/guide/quick-start.html#%E8%8F%9C%E5%8D%95%E5%9B%BE%E6%A0%87%E5%AF%BC%E5%85%A5)
2. **推荐** 使用菜单自行配置 (跟 cloud 版本打开方式一致)
![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/菜单修改.png)
使用内嵌 iframe 方式需要解决跨域问题 可参考[nginx.conf](https://gitee.com/dromara/RuoYi-Vue-Plus/blob/5.X/script/docker/nginx/conf/nginx.conf#LC87)配置
- 运行
运行
```bash
pnpm dev:antd
```
4. 打包
打包
```bash
pnpm build:antd