diff --git a/README.zh-CN.md b/README.zh-CN.md index d720ffe6..604d5bda 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -1,103 +1,128 @@ -开发中: +[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE)

ruoYi plus vben5

-工作流模块等待后端重构后开发 暂时不开发 +## 提示 -**目前表格仅为测试使用 不代表最终版本** - -其他: - -1. 等待官方Table组件 -2. 已完成所有表单开发 - -演示站: [点击前往](https://vben5.dapdap.top) - -贡献规范: - -文件夹/组件采用短横线命名法: 比如 `a-table.vue test-form.vue` - -组件导入采用手动导入&大写(button/input等常用除外 可正常使用a-button/a-input) 与html标签区分开 - -```vue - - - -``` - -
VbenAdmin Logo

- -[![license](https://img.shields.io/github/license/anncwb/vue-vben-admin.svg)](LICENSE) - -

Vue Vben Admin

-
- -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=vbenjs_vue-vben-admin&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=vbenjs_vue-vben-admin) ![codeql](https://github.com/vbenjs/vue-vben-admin/actions/workflows/codeql.yml/badge.svg) ![build](https://github.com/vbenjs/vue-vben-admin/actions/workflows/build.yml/badge.svg) ![ci](https://github.com/vbenjs/vue-vben-admin/actions/workflows/ci.yml/badge.svg) ![deploy](https://github.com/vbenjs/vue-vben-admin/actions/workflows/deploy.yml/badge.svg) - -**中文** | [English](./README.md) | [日本語](./README.ja-JP.md) +该仓库使用vben最新版本v5开发, 老版本v2地址[前往](https://gitee.com/dapppp/ruoyi-plus-vben) ## 简介 -Vue Vben Admin 是 Vue Vben Admin 的升级版本。作为一个免费开源的中后台模板，它采用了最新的 Vue 3、Vite、TypeScript 等主流技术开发，开箱即用，可用于中后台前端开发，也适合学习参考。 +基于 [vben5 & ant-design-vue)](https://github.com/vbenjs/vue-vben-admin) 的 RuoYi-Vue-Plus 前端项目 -## 升级提示 +| 组件/框架 | 版本 | +| :------------- | :---- | +| vben | 5.31 | +| ant-design-vue | 4.2.5 | +| vue | 3.5.1 | -该版本为最新版本`5.0`, 与其他版本不兼容，如果你是新项目，建议使用最新版本。如果你想查看旧版本，请使用 [v2 分支](https://github.com/vbenjs/vue-vben-admin/tree/v2) +对应后端项目: **(分布式 5.X 分支 微服务 2.分支)** -## 特性 +分布式 [RuoYi-Vue-Plus](https://gitee.com/dromara/RuoYi-Vue-Plus/tree/5.X/) -- **最新技术栈**：使用 Vue3/vite 等前端前沿技术开发 -- **TypeScript**: 应用程序级 JavaScript 的语言 -- **主题**：提供多套主题色彩，可配置自定义主题 -- **国际化**：内置完善的国际化方案 -- **权限** 内置完善的动态路由权限生成方案 +微服务 [RuoYi-Cloud-Plus](https://gitee.com/dromara/RuoYi-Cloud-Plus/tree/2.X/) ## 预览 -- [Vben Admin](https://vben.pro/) - 完整版中文站点 +admin 账号: admin admin123 -测试账号: vben/123456 +[预览地址点这里](http://vben5.dapdap.top) -

- VbenAdmin Logo - VbenAdmin Logo - VbenAdmin Logo -

+## WX Group -### 使用 Gitpod - -在 Gitpod（适用于 GitHub 的免费在线开发环境）中打开项目，并立即开始编码. - -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/vbenjs/vue-vben-admin) +暂不开放 ## 文档 -[文档地址](https://doc.vben.pro/) +[vben 文档地址](https://doc.vvbin.cn/) + +[RuoYi-Plus 文档地址](https://plus-doc.dromara.org/#/) + +## 预览图 + +![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/1.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/2.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/3.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/4.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/5.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/6.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/7.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/8.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/9.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/10.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/11.png) ![图片](https://gitee.com/dapppp/ruoyi-plus-vben/raw/main/preview/12.png) ## 安装使用 +前置准备环境(只能用pnpm) + +```json +"packageManager": "pnpm", +"engines": { + "node": ">=20.10.0", + "pnpm": ">=9.5.0" +}, +``` + - 获取项目代码 ```bash -git clone https://github.com/vbenjs/vue-vben-admin.git +git clone https://gitee.com/dapppp/ruoyi-plus-vben5.git ``` - 安装依赖 ```bash -cd vue-vben-admin - -corepack enable +cd ruoyi-plus-vben5 pnpm install ``` +- 关于代码生成(非必选) + +v5版本代码生成模板为付费功能 + +- 关于一些监控的地址配置(微服务版本可以跳过这一小节) + +使用[RuoYi-Vue-Plus](https://gitee.com/dromara/RuoYi-Vue-Plus/tree/5.X/)注意 `已经去除 admin/snailjob 的.env 配置` 可自行修改 有两种方式 + +1. 修改源码`/views/monitor/admin` `views/monitor/snailjob` + +```ts +// 修改地址 +const url = ref('http://127.0.0.1:7700/#/oms/home'); +``` + +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)配置 + +- 修改.env.development 配置文件 +- **注意 RSA 公私钥一定要修改和后端匹配** +- RSA 公私钥为两对 `前端请求加密-后端解密是一对` `后端响应加密 前端解密是一对` + +```properties +# 端口号 +VITE_PORT=5666 + +VITE_BASE=/ +# 是否开启 Nitro Mock服务，true 为开启，false 为关闭 +VITE_NITRO_MOCK=false +# 是否打开 devtools，true 为打开，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 +``` + - 运行 ```bash -pnpm dev +pnpm serve ``` - 打包 @@ -106,22 +131,6 @@ pnpm dev pnpm build ``` -## 更新日志 - -[CHANGELOG](https://github.com/vbenjs/vue-vben-admin/releases) - -## 如何贡献 - -非常欢迎你的加入！[提一个 Issue](https://github.com/anncwb/vue-vben-admin/issues/new/choose) 或者提交一个 Pull Request。 - -**Pull Request:** - -1. Fork 代码! -2. 创建自己的分支: `git checkout -b feature/xxxx` -3. 提交你的修改: `git commit -am 'feat(function): add xxxxx'` -4. 推送您的分支: `git push origin feature/xxxx` -5. 提交`pull request` - ## Git 贡献提交规范 - 参考 [vue](https://github.com/vuejs/vue/blob/dev/.github/COMMIT_CONVENTION.md) 规范 ([Angular](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)) @@ -135,13 +144,16 @@ pnpm build - `test` 测试相关 - `docs` 文档/注释 - `chore` 依赖更新/脚手架配置修改等 + - `workflow` 工作流改进 - `ci` 持续集成 - `types` 类型定义文件更改 - `wip` 开发中 ## 浏览器支持 -本地开发推荐使用`Chrome 80+` 浏览器 +最低适配应该为`Chrome 88+`以上浏览器 详见 [css - where](https://developer.mozilla.org/en-US/docs/Web/CSS/:where#browser_compatibility) + +本地开发推荐使用`Chrome` 最新版本浏览器 支持现代浏览器, 不支持 IE @@ -149,33 +161,8 @@ pnpm build | :-: | :-: | :-: | :-: | :-: | | not support | last 2 versions | last 2 versions | last 2 versions | last 2 versions | -## 维护者 - -[@Vben](https://github.com/anncwb) - -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=vbenjs/vue-vben-admin&type=Date)](https://star-history.com/#vbenjs/vue-vben-admin&Date) - ## 捐赠 -如果你觉得这个项目对你有帮助，你可以帮作者买一杯咖啡表示支持! +如果项目帮助到您 可以考虑请作者喝杯咖啡 万分感谢您对开源的支持! -![donate](https://unpkg.com/@vbenjs/static-source@0.1.7/source/sponsor.png) - -Paypal Me - -## Contributor - - - Contributors - - -## Discord - -- [Github Discussions](https://github.com/anncwb/vue-vben-admin/discussions) - -## License - -[MIT © Vben-2020](./LICENSE) + diff --git a/scripts/preview/1.png b/scripts/preview/1.png new file mode 100644 index 00000000..d538d124 Binary files /dev/null and b/scripts/preview/1.png differ diff --git a/scripts/preview/10.png b/scripts/preview/10.png new file mode 100644 index 00000000..30103d4e Binary files /dev/null and b/scripts/preview/10.png differ diff --git a/scripts/preview/2.png b/scripts/preview/2.png new file mode 100644 index 00000000..3a4889b8 Binary files /dev/null and b/scripts/preview/2.png differ diff --git a/scripts/preview/3.png b/scripts/preview/3.png new file mode 100644 index 00000000..fd0ce943 Binary files /dev/null and b/scripts/preview/3.png differ diff --git a/scripts/preview/4.png b/scripts/preview/4.png new file mode 100644 index 00000000..822e7bda Binary files /dev/null and b/scripts/preview/4.png differ diff --git a/scripts/preview/5.png b/scripts/preview/5.png new file mode 100644 index 00000000..5a58fd15 Binary files /dev/null and b/scripts/preview/5.png differ diff --git a/scripts/preview/6.png b/scripts/preview/6.png new file mode 100644 index 00000000..03f1038e Binary files /dev/null and b/scripts/preview/6.png differ diff --git a/scripts/preview/7.png b/scripts/preview/7.png new file mode 100644 index 00000000..80ebb228 Binary files /dev/null and b/scripts/preview/7.png differ diff --git a/scripts/preview/8.png b/scripts/preview/8.png new file mode 100644 index 00000000..1e9f9b2d Binary files /dev/null and b/scripts/preview/8.png differ diff --git a/scripts/preview/9.png b/scripts/preview/9.png new file mode 100644 index 00000000..20d497dc Binary files /dev/null and b/scripts/preview/9.png differ