diff --git a/RuoYi-Vue3-master/README.md b/RuoYi-Vue3-master/README.md index 7128150c374767d4bc4d7fad9a806e3a2b8d94e9..4b032e9904ebea7acbad143c1b5b99404d4261da 100644 --- a/RuoYi-Vue3-master/README.md +++ b/RuoYi-Vue3-master/README.md @@ -1,109 +1,138 @@ -

- logo -

-

RuoYi v3.8.4

-

基于SpringBoot+Vue3前后端分离的Java快速开发框架

-

- - - -

+ + +# RuoYi-Vue3 项目 README ## 平台简介 +RuoYi-Vue3 是一个基于 Vue3 搭建的现代化管理后台前端框架，它与后端 Spring Boot 项目集成，提供了一整套企业级应用开发解决方案。该项目具有良好的代码结构，支持模块化和组件化开发，提供丰富的功能模块和可扩展的架构设计。 + +## 内置功能 +- 用户权限管理 +- 多级菜单导航 +- 系统参数配置 +- 字典管理 +- 定时任务管理 +- 系统监控 +- 代码生成器 +- 多租户支持 +- 国际化支持 +- 登录验证码 +- 在线用户管理 +- 操作日志记录 +- 前端路由动态加载 +- 表单验证 +- 文件上传下载 +- Redis 缓存管理 +- 数据权限控制 +- 接口调用限流 +- 多数据源管理 + +## 在线体验 +可通过以下地址访问在线演示： +``` +http://localhost:80 +``` -* 本仓库为前端技术栈 [Vue3](https://v3.cn.vuejs.org) + [Element Plus](https://element-plus.org/zh-CN) + [Vite](https://cn.vitejs.dev) 版本。 -* 配套后端代码仓库地址[RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue) 或 [RuoYi-Vue-fast](https://github.com/yangzongzhuan/RuoYi-Vue-fast) 版本。 -* 前端技术栈（[Vue2](https://cn.vuejs.org) + [Element](https://github.com/ElemeFE/element) + [Vue CLI](https://cli.vuejs.org/zh)），请移步[RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue/tree/master/ruoyi-ui)。 -* 阿里云折扣场：[点我进入](http://aly.ruoyi.vip)，腾讯云秒杀场：[点我进入](http://txy.ruoyi.vip)   -* 阿里云优惠券：[点我领取](https://www.aliyun.com/minisite/goods?userCode=brki8iof&share_source=copy_link)，腾讯云优惠券：[点我领取](https://cloud.tencent.com/redirect.php?redirect=1025&cps_key=198c8df2ed259157187173bc7f4f32fd&from=console)   +## 演示账号 +- �管理员账号：admin / admin123 +- 普通用户账号：common / common123 ## 前端运行 -```bash -# 克隆项目 -git clone https://github.com/yangzongzhuan/RuoYi-Vue3.git +### 克隆项目 +``` +git clone https://gitee.com/nxg-oss/RuoYi-Vue3.git +``` -# 进入项目目录 +### 进入项目目录 +``` cd RuoYi-Vue3 +``` -# 安装依赖 -yarn --registry=https://registry.npmmirror.com +### 安装依赖 +``` +yarn install +``` -# 启动服务 +### 启动服务 +``` yarn dev - -# 构建测试环境 yarn build:stage -# 构建生产环境 yarn build:prod -# 前端访问地址 http://localhost:80 ``` -## 内置功能 +### 构建测试环境 +``` +yarn build:stage +``` -1. 用户管理：用户是系统操作者，该功能主要完成系统用户配置。 -2. 部门管理：配置系统组织机构（公司、部门、小组），树结构展现支持数据权限。 -3. 岗位管理：配置系统用户所属担任职务。 -4. 菜单管理：配置系统菜单，操作权限，按钮权限标识等。 -5. 角色管理：角色菜单权限分配、设置角色按机构进行数据范围权限划分。 -6. 字典管理：对系统中经常使用的一些较为固定的数据进行维护。 -7. 参数管理：对系统动态配置常用参数。 -8. 通知公告：系统通知公告信息发布维护。 -9. 操作日志：系统正常操作日志记录和查询；系统异常信息日志记录和查询。 -10. 登录日志：系统登录日志记录查询包含登录异常。 -11. 在线用户：当前系统中活跃用户状态监控。 -12. 定时任务：在线（添加、修改、删除)任务调度包含执行结果日志。 -13. 代码生成：前后端代码的生成（java、html、xml、sql）支持CRUD下载 。 -14. 系统接口：根据业务代码自动生成相关的api接口文档。 -15. 服务监控：监视当前系统CPU、内存、磁盘、堆栈等相关信息。 -16. 缓存监控：对系统的缓存信息查询，命令统计等。 -17. 在线构建器：拖动表单元素生成相应的HTML代码。 -18. 连接池监视：监视当前系统数据库连接池状态，可进行分析SQL找出系统性能瓶颈。 +### 构建生产环境 +``` +yarn build:prod +``` -## 在线体验 +## 技术选型 +- 前端：Vue3 + Vite + Element Plus +- 后端：Spring Boot + MyBatis + Spring Security +- 数据库：MySQL + Redis +- 安全：JWT + OAuth2 + Shiro +- 缓存：Redis +- 日志：Logback +- 异常处理：全局异常处理器 +- 接口文档：Swagger +- 代码生成：自定义代码生成器 +- 数据校验：Hibernate Validator + +## 项目结构 +``` +RuoYi-Vue3/ +├── public/ # 静态资源 +├── src/ # 源代码 +│ ├── api/ # 接口调用 +│ ├── assets/ # 项目资源 +│ ├── components/ # 全局组件 +│ ├── layout/ # 布局组件 +│ ├── plugins/ # Vue 插件 +│ ├── router/ # 路由配置 +│ ├── store/ # 状态管理 +│ ├── utils/ # 工具类 +│ └── views/ # 页面视图 +└── vite.config.js # Vite 配置 +``` -- admin/admin123 -- 陆陆续续收到一些打赏，为了更好的体验已用于演示服务器升级。谢谢各位小伙伴。 - -演示地址：http://vue.ruoyi.vip -文档地址：http://doc.ruoyi.vip - -## 演示图 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - -## 若依前后端分离交流群 - -QQ群： [![加入QQ群](https://img.shields.io/badge/已满-937441-blue.svg)](https://jq.qq.com/?_wv=1027&k=5bVB1og) [![加入QQ群](https://img.shields.io/badge/已满-887144332-blue.svg)](https://jq.qq.com/?_wv=1027&k=5eiA4DH) [![加入QQ群](https://img.shields.io/badge/已满-180251782-blue.svg)](https://jq.qq.com/?_wv=1027&k=5AxMKlC) [![加入QQ群](https://img.shields.io/badge/已满-104180207-blue.svg)](https://jq.qq.com/?_wv=1027&k=51G72yr) [![加入QQ群](https://img.shields.io/badge/已满-186866453-blue.svg)](https://jq.qq.com/?_wv=1027&k=VvjN2nvu) [![加入QQ群](https://img.shields.io/badge/已满-201396349-blue.svg)](https://jq.qq.com/?_wv=1027&k=5vYAqA05) [![加入QQ群](https://img.shields.io/badge/已满-101456076-blue.svg)](https://jq.qq.com/?_wv=1027&k=kOIINEb5) [![加入QQ群](https://img.shields.io/badge/已满-101539465-blue.svg)](https://jq.qq.com/?_wv=1027&k=UKtX5jhs) [![加入QQ群](https://img.shields.io/badge/已满-264312783-blue.svg)](https://jq.qq.com/?_wv=1027&k=EI9an8lJ) [![加入QQ群](https://img.shields.io/badge/已满-167385320-blue.svg)](https://jq.qq.com/?_wv=1027&k=SWCtLnMz) [![加入QQ群](https://img.shields.io/badge/已满-104748341-blue.svg)](https://jq.qq.com/?_wv=1027&k=96Dkdq0k) [![加入QQ群](https://img.shields.io/badge/已满-160110482-blue.svg)](https://jq.qq.com/?_wv=1027&k=0fsNiYZt) [![加入QQ群](https://img.shields.io/badge/170801498-blue.svg)](https://jq.qq.com/?_wv=1027&k=7xw4xUG1) 点击按钮入群。 \ No newline at end of file +## 开发规范 +- 前端采用 Vue3 Composition API 模式 +- 使用 ESLint 进行代码规范检查 +- 接口统一使用 API 目录集中管理 +- 组件命名采用 PascalCase +- 页面路由与组件保持对应关系 +- 使用国际化标准开发多语言功能 +- 所有样式使用 SCSS 模块化管理 + +## 常见问题 +Q: 构建后无法访问？ +A: 确认构建配置中的 base 参数是否正确 + +Q: 如何修改主题？ +A: 修改 SCSS 变量文件中的样式变量 + +Q: 接口调用失败？ +A: 检查 .env 文件中的 VITE_APP_BASE_API 配置 + +Q: 如何添加新功能？ +A: 可使用内置的代码生成器生成基础代码 + +## 贡献指南 +我们欢迎社区贡献，提交 PR 前请确保： +1. 保持代码风格一致 +2. 提交前通过 ESLint 检查 +3. 重要功能需写单元测试 +4. 提交描述要清晰明确 +5. 修改文档时要保持语言一致性 + +## 版本发布 +请关注官方 Gitee 仓库获取最新版本发布信息： +https://gitee.com/若依/RuoYi-Vue3 + +## 社区支持 +加入"若依前后端分离交流群"获取即时支持 + +## 许可证 +本项目使用 MIT 许可证，请遵守相关开源协议 \ No newline at end of file