ruoyi-plus-vben5/README.zh-CN.md
2024-10-20 13:27:58 +08:00

7.3 KiB
Raw Blame History

license

提示

该仓库使用vben最新版本v5开发, 老版本v2地址 前往

v5版本采用分仓(包)目录结构, 具体开发路径为: 根目录/apps/web-antd

进度

工作流相关模块等待后端重构后开发

基础功能已经开发完毕

👉 更新日志

简介

基于 vben5 & ant-design-vue 的 RuoYi-Vue-Plus 前端项目

组件/框架 版本
vben 5.4.1
ant-design-vue 4.2.5
vue 3.5.11

对应后端项目: (分布式 5.X 分支 微服务 2.分支)

分布式 RuoYi-Vue-Plus

微服务 RuoYi-Cloud-Plus

预览

admin 账号: admin admin123

预览地址点这里

WX Group

演示站 - 微信群菜单

文档

本框架文档 强烈建议阅读

Vben V5 文档地址

RuoYi-Plus 文档地址

预览图

图片 图片 图片 图片 图片 图片 图片 图片 图片 图片

安装使用

前置准备环境(只能用pnpm)

"packageManager": "pnpm",
"engines": {
  "node": ">=20.15.0",
  "pnpm": "latest"
},
  • 获取项目代码
git clone https://gitee.com/dapppp/ruoyi-plus-vben5.git
  • 安装依赖
cd ruoyi-plus-vben5

pnpm install
  • 菜单图标替换

根目录/scripts/菜单图标替换sql/update_icon.sql

  • 关于代码生成

V5版本代码生成模板为付费功能 详见

  • 关于一些监控的地址配置(微服务版本可以跳过这一小节)

使用RuoYi-Vue-Plus注意 已经去除 admin/snailjob 的.env 配置 可自行修改 有两种方式

  1. 修改源码/views/monitor/admin views/monitor/snailjob
<!-- 修改地址 -->
<template>
  <iframe
    class="size-full"
    src="http://localhost:9090/admin/applications"
  ></iframe>
</template>
  1. 推荐 使用菜单自行配置 (跟 cloud 版本打开方式一致)

图片

使用内嵌 iframe 方式需要解决跨域问题 可参考nginx.conf配置

  • 修改.env.development 配置文件
  • 注意 RSA 公私钥一定要修改和后端匹配
  • RSA 公私钥为两对 前端请求加密-后端解密是一对 后端响应加密 前端解密是一对
# 端口号
VITE_PORT=5666
# 打包路径
VITE_BASE=/
# 是否开启 Nitro Mock服务true 为开启false 为关闭
VITE_NITRO_MOCK=false
# 是否打开 devtoolstrue 为打开false 为关闭
VITE_DEVTOOLS=false
# 是否注入全局loading
VITE_INJECT_APP_LOADING=true

# 后台请求路径 具体在vite.config.mts配置代理
VITE_GLOB_API_URL=/api
# 全局加密开关(即开启了加解密功能才会生效 不是全部接口加密 需要和后端对应)
VITE_GLOB_ENABLE_ENCRYPT=true
# RSA公钥 请求加密使用 注意这两个是两对RSA公私钥 请求加密-后端解密是一对 响应解密-后端加密是一对
VITE_GLOB_RSA_PUBLIC_KEY=
# RSA私钥 响应解密使用 注意这两个是两对RSA公私钥 请求加密-后端解密是一对 响应解密-后端加密是一对
VITE_GLOB_RSA_PRIVATE_KEY=
# 客户端id
VITE_GLOB_APP_CLIENT_ID=e5cd7e4891bf95d1d19206ce24a7b32e
# 开启WEBSOCKET
VITE_GLOB_WEBSOCKET_ENABLE=false
  • 运行
pnpm dev:antd
  • 打包
pnpm build:antd

这是一个特性 而不是一个bug!

  1. 菜单管理可分配 但只有admin/superadmin角色能访问 其他角色访问会到403页面
  2. 租户相关菜单可分配 但只有superadmin角色能访问 其他角色访问会到403页面
  3. 分配的租户管理员无法修改自己的角色的菜单(即管理员角色的菜单) 防止自己把自己权限弄没了

Git 贡献提交规范

  • 参考 vue 规范 (Angular)

    • feat 增加新功能
    • fix 修复问题/BUG
    • style 代码风格相关无影响运行结果的
    • perf 优化/性能提升
    • refactor 重构
    • revert 撤销修改
    • test 测试相关
    • docs 文档/注释
    • chore 依赖更新/脚手架配置修改等
    • workflow 工作流改进
    • ci 持续集成
    • types 类型定义文件更改
    • wip 开发中

浏览器支持

最低适配应该为Chrome 88+以上浏览器 详见 css - where

本地开发推荐使用Chrome 最新版本浏览器

支持现代浏览器, 不支持 IE

 Edge
IE
 Edge
Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
not support last 2 versions last 2 versions last 2 versions last 2 versions

捐赠

如果项目帮助到您 可以考虑请作者喝杯咖啡 万分感谢您对开源的支持!