ruoyi-flex/README.md

112 lines
5.8 KiB
Markdown
Raw Normal View History

<p align="center">
2023-12-07 15:22:25 +08:00
<img alt="logo" src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/ruoyi-flex-logo.png">
</p>
2023-12-07 15:22:25 +08:00
<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">Ruoyi-Flex V4.1.8</h1>
2023-12-10 08:55:54 +08:00
<h4 align="center">Ruoyi-Flex是基于JDK21、Spring Boot V3.2.X+平台 前后端分离的Java快速开发框架</h4>
2023-07-05 10:33:01 +08:00
## 1、平台简介
2023-07-05 10:33:01 +08:00
2023-12-10 08:55:54 +08:00
Ruoyi-Flex是一套全部开源的快速开发平台使用MIT开源许可协议毫无保留给个人及企业免费使用。基于RuoYi-Vue、RuoYi-Vue-Plus集成MyBatis-Flex、JDK21、SpringBootV3.2.X+、Lombok、Sa-Token、SpringDoc、Hutool、SpringBoot Admin、PowerJob、Vue3、Element-Plus、MinIO等优秀开源软件
2023-07-05 10:33:01 +08:00
* 前端采用Vue3、Element-Plus。
2023-12-10 08:55:54 +08:00
* 后端采用JDK21、Spring Boot V3.2.X+、MyBatis-Flex、Sa-Token、Redis & Jwt、PowerJob、MinIO。
* 权限认证使用Jwt支持多终端认证系统。
* 支持加载动态权限菜单,多方式轻松权限控制。
2023-09-18 09:50:27 +08:00
* 定制模板,使用代码生成器可以一键生成前后端代码。
2023-12-07 15:22:25 +08:00
* **用WithRelation编程装配来取代数据库LeftJoin关联查询数据库执行效率提高10倍**
* 性能卓越功能全面开发高效可免除手写SQL之苦甚至写错字段名称IDEA都会立即报警。
* 写得更少、运行更快、编译除错、效率更高!
2023-07-05 10:33:01 +08:00
## 2、前端项目
2023-12-10 11:13:07 +08:00
Ruoyi-Flex实行前后端分离仓库本项目是java后端部分前端项目是flex-elementplus-ui前端项目地址: [flex-elementplus-ui](https://gitee.com/dataprince/flex-elementplus-ui)
2023-07-05 10:33:01 +08:00
## 3、内置功能
2023-07-05 10:33:01 +08:00
1. 用户管理:用户是系统操作者,该功能主要完成系统用户配置。
2. 部门管理:配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。
3. 岗位管理:配置系统用户所属担任职务。
4. 菜单管理:配置系统菜单,操作权限,按钮权限标识等。
5. 角色管理:角色菜单权限分配、设置角色按机构进行数据范围权限划分。
6. 字典管理:对系统中经常使用的一些较为固定的数据进行维护。
7. 参数管理:对系统动态配置常用参数。
8. 通知公告:系统通知公告信息发布维护。
9. 操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。
10. 登录日志:系统登录日志记录查询包含登录异常。
11. 文件管理引入云存储服务将文件存储到MinIO、七牛、阿里、腾讯等OSS服务器上支持上传、下载。
2023-12-07 15:22:25 +08:00
12. 在线用户:当前系统中活跃用户状态监控。
13. 调度中心集成PowerJob全新一代分布式任务调度与计算框架。
14. 代码生成前后端代码的生成java、html、vue、js支持单表、树表、主子表减少70%以上的开发工作量。
2023-12-07 15:22:25 +08:00
15. 系统接口集成springdoc根据文档注释自动生成相关的api接口文档。
16. 监控中心集成Spring Boot Admin监视集群系统CPU、内存、磁盘、堆栈、在线日志、Spring相关配置等。
17. 缓存监控:对系统的缓存信息查询,命令统计等。
18. 演示模块mybatis、mybatis-flex两种格式代码的单表、树表、主子表三种类型的演示程序。
2023-07-05 10:33:01 +08:00
## 4、开发文档
2023-07-05 10:33:01 +08:00
本项目提供保姆级开发文档,零基础手把手入门教程,位于/doc文件夹下面
2023-09-18 09:50:27 +08:00
入门必读,请下载到本地查看:《[Ruoyi-Flex开发编译手册.docx](https://gitee.com/dataprince/ruoyi-flex/raw/master/doc/Ruoyi-Flex-Guide.docx)》。
## 5、Ruoyi-Flex交流群
2023-12-10 08:55:54 +08:00
本软件完全开源作者很忙如果您在使用过程中遇到问题请付点小费扫码支付199元后申请加入QQ群或者微信群寻求帮助
<table>
<tr>
2023-12-11 17:16:47 +08:00
<td>1、QQ交流群</td>
<td>762217712[交流1群]</td>
</tr>
<tr>
<td>2、微信交流群</td>
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/dataprince.jpg"/></td>
</tr>
</table>
2023-07-05 10:33:01 +08:00
## 6、开源协议
2023-09-19 21:31:51 +08:00
**为什么推荐使用本项目?**
① 本项目采用比 Apache 2.0 更宽松的 [MIT License](https://gitee.com/dataprince/ruoyi-flex/blob/master/LICENSE) 开源协议,个人与企业可 100% 免费使用不用保留类作者、Copyright 信息。
② 代码全部开源,不会像其它项目一样,只开源部分代码,让你无法了解整个项目的架构设计。
如果这个项目让您有所收获,记得 Star 关注哦,这对我是非常不错的鼓励与支持。
## 7、演示图
2023-07-05 10:33:01 +08:00
<table>
<tr>
2023-12-11 17:16:47 +08:00
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/main.JPG"/></td>
2023-09-16 20:50:48 +08:00
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/manul.JPG"/></td>
</tr>
<tr>
2023-12-11 17:16:47 +08:00
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/user.JPG"/></td>
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/role.JPG"/></td>
</tr>
<tr>
2023-12-11 17:16:47 +08:00
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/powerjob.JPG"/></td>
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/springbootadmin.JPG"/></td>
</tr>
<tr>
2023-12-11 17:16:47 +08:00
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/oss.JPG"/></td>
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/gen.JPG"/></td>
</tr>
<tr>
2023-12-11 17:16:47 +08:00
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/master.JPG"/></td>
<td><img src="https://gitee.com/dataprince/ruoyi-flex/raw/master/image/preview.JPG"/></td>
2023-07-05 15:00:50 +08:00
</tr>
</table>
2023-07-05 10:33:01 +08:00
## 8、参与贡献
2023-12-10 11:13:07 +08:00
1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request
## 9、特别鸣谢
2023-08-26 19:06:04 +08:00
- [RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue)
- [RuoYi-Vue-Plus](https://gitee.com/dromara/RuoYi-Vue-Plus)
- [MyBatis-Flex](https://gitee.com/mybatis-flex/mybatis-flex)