RuoYi пре 5 година
родитељ
комит
e954b812c4
2 измењених фајлова са 96 додато и 63 уклоњено
  1. 0 36
      README.en.md
  2. 96 27
      README.md

+ 0 - 36
README.en.md

@@ -1,36 +0,0 @@
1
-# RuoYi-Cloud
2
-
3
-#### Description
4
-{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**}
5
-
6
-#### Software Architecture
7
-Software architecture description
8
-
9
-#### Installation
10
-
11
-1.  xxxx
12
-2.  xxxx
13
-3.  xxxx
14
-
15
-#### Instructions
16
-
17
-1.  xxxx
18
-2.  xxxx
19
-3.  xxxx
20
-
21
-#### Contribution
22
-
23
-1.  Fork the repository
24
-2.  Create Feat_xxx branch
25
-3.  Commit your code
26
-4.  Create Pull Request
27
-
28
-
29
-#### Gitee Feature
30
-
31
-1.  You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md
32
-2.  Gitee blog [blog.gitee.com](https://blog.gitee.com)
33
-3.  Explore open source project [https://gitee.com/explore](https://gitee.com/explore)
34
-4.  The most valuable open source project [GVP](https://gitee.com/gvp)
35
-5.  The manual of Gitee [https://gitee.com/help](https://gitee.com/help)
36
-6.  The most popular members  [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)

+ 96 - 27
README.md

@@ -1,39 +1,108 @@
1
-# RuoYi-Cloud
1
+## 平台简介
2 2
 
3
-#### 介绍
4
-{**以下是码云平台说明,您可以替换此简介**
5
-码云是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台
6
-无论是个人、团队、或是企业,都能够用码云实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)}
3
+* 采用前后端分离的模式,微服务版本前端(基于 [RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue))。
4
+* 后端采用Spring Boot、Spring Cloud & Alibaba、OAuth2。
5
+* 注册中心、配置中心选型Nacos,为工程瘦身的同时加强各模块之间的联动。
6
+* 权限认证使用OAuth2,实现了多终端认证系统,可控制业务模块权限。
7
+* 项目分包明确,规范微服务的开发模式,使包与包之间的分工清晰。
8
+* 如需不分离应用,请移步 [RuoYi](https://gitee.com/y_project/RuoYi),如需分离应用,请移步 [RuoYi-Vue](https://gitee.com/y_project/RuoYi-Vue)
9
+* 阿里云优惠券:[点我进入](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)  
7 10
 
8
-#### 软件架构
9
-软件架构说明
11
+## 系统模块
10 12
 
13
+~~~
14
+com.ruoyi     
15
+├── ruoyi-ui              // 前端框架 [80]
16
+├── ruoyi-gateway         // 网关模块 [8080]
17
+├── ruoyi-auth            // 认证中心 [9200]
18
+├── ruoyi-api             // 接口模块
19
+│       └── ruoyi-api-system                          // 系统接口
20
+├── ruoyi-common          // 通用模块
21
+│       └── ruoyi-common-core                         // 核心模块
22
+│       └── ruoyi-common-datascope                    // 权限范围
23
+│       └── ruoyi-common-log                          // 日志记录
24
+│       └── ruoyi-common-redis                        // 缓存服务
25
+│       └── ruoyi-common-security                     // 安全模块
26
+│       └── ruoyi-common-swagger                      // 系统接口
27
+├── ruoyi-modules         // 业务模块
28
+│       └── ruoyi-system                              // 系统模块 [9201]
29
+│       └── ruoyi-gen                                 // 代码生成 [9202]
30
+│       └── ruoyi-job                                 // 定时任务 [9203]
31
+├── ruoyi-visual          // 图形化管理模块
32
+│       └── ruoyi-visual-monitor                      // 监控中心 [9100]
33
+├──pom.xml                // 公共依赖
34
+~~~
11 35
 
12
-#### 安装教程
36
+## 架构图
13 37
 
14
-1.  xxxx
15
-2.  xxxx
16
-3.  xxxx
38
+<img src="https://oscimg.oschina.net/oscnet/up-aaa2d885b0fba37e52b56f0948edde1c4fe.png"/>
17 39
 
18
-#### 使用说明
40
+## 内置功能
19 41
 
20
-1.  xxxx
21
-2.  xxxx
22
-3.  xxxx
42
+1.  用户管理:用户是系统操作者,该功能主要完成系统用户配置。
43
+2.  部门管理:配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。
44
+3.  岗位管理:配置系统用户所属担任职务。
45
+4.  菜单管理:配置系统菜单,操作权限,按钮权限标识等。
46
+5.  角色管理:角色菜单权限分配、设置角色按机构进行数据范围权限划分。
47
+6.  字典管理:对系统中经常使用的一些较为固定的数据进行维护。
48
+7.  参数管理:对系统动态配置常用参数。
49
+8.  通知公告:系统通知公告信息发布维护。
50
+9.  操作日志:系统正常操作日志记录和查询;系统异常信息日志记录和查询。
51
+10. 登录日志:系统登录日志记录查询包含登录异常。
52
+11. 在线用户:当前系统中活跃用户状态监控。
53
+12. 定时任务:在线(添加、修改、删除)任务调度包含执行结果日志。
54
+13. 代码生成:前后端代码的生成(java、html、xml、sql)支持CRUD下载 。
55
+14. 系统接口:根据业务代码自动生成相关的api接口文档。
56
+15. 服务监控:监视当前系统CPU、内存、磁盘、堆栈等相关信息。
57
+16. 在线构建器:拖动表单元素生成相应的HTML代码。
58
+17. 连接池监视:监视当前系统数据库连接池状态,可进行分析SQL找出系统性能瓶颈。
23 59
 
24
-#### 参与贡献
60
+## 在线体验
25 61
 
26
-1.  Fork 本仓库
27
-2.  新建 Feat_xxx 分支
28
-3.  提交代码
29
-4.  新建 Pull Request
62
+- admin/admin123  
63
+- 陆陆续续收到一些打赏,为了更好的体验已用于演示服务器升级。谢谢各位小伙伴。
30 64
 
65
+演示地址:http://ruoyi.vip  
66
+文档地址:http://doc.ruoyi.vip
31 67
 
32
-#### 码云特技
68
+## 演示图
33 69
 
34
-1.  使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md
35
-2.  码云官方博客 [blog.gitee.com](https://blog.gitee.com)
36
-3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目
37
-4.  [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目
38
-5.  码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
39
-6.  码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)
70
+<table>
71
+    <tr>
72
+        <td><img src="https://oscimg.oschina.net/oscnet/cd1f90be5f2684f4560c9519c0f2a232ee8.jpg"/></td>
73
+        <td><img src="https://oscimg.oschina.net/oscnet/1cbcf0e6f257c7d3a063c0e3f2ff989e4b3.jpg"/></td>
74
+    </tr>
75
+    <tr>
76
+        <td><img src="https://oscimg.oschina.net/oscnet/707825ad3f29de74a8d6d02fbd73ad631ea.jpg"/></td>
77
+        <td><img src="https://oscimg.oschina.net/oscnet/46be40cc6f01aa300eed53a19b5012bf484.jpg"/></td>
78
+    </tr>
79
+    <tr>
80
+        <td><img src="https://oscimg.oschina.net/oscnet/4284796d4cea240d181b8f2201813dda710.jpg"/></td>
81
+        <td><img src="https://oscimg.oschina.net/oscnet/3ecfac87a049f7fe36abbcaafb2c40d36cf.jpg"/></td>
82
+    </tr>
83
+	<tr>
84
+        <td><img src="https://oscimg.oschina.net/oscnet/71c2d48905221a09a728df4aff4160b8607.jpg"/></td>
85
+        <td><img src="https://oscimg.oschina.net/oscnet/c14c1ee9a64a6a9c2c22f67d43198767dbe.jpg"/></td>
86
+    </tr>	 
87
+    <tr>
88
+        <td><img src="https://oscimg.oschina.net/oscnet/5e8c387724954459291aafd5eb52b456f53.jpg"/></td>
89
+        <td><img src="https://oscimg.oschina.net/oscnet/644e78da53c2e92a95dfda4f76e6d117c4b.jpg"/></td>
90
+    </tr>
91
+	<tr>
92
+        <td><img src="https://oscimg.oschina.net/oscnet/fdea1d8bb8625c27bf964176a2c8ebc6945.jpg"/></td>
93
+        <td><img src="https://oscimg.oschina.net/oscnet/509d2708cfd762b6e6339364cac1cc1970c.jpg"/></td>
94
+    </tr>
95
+	<tr>
96
+        <td><img src="https://oscimg.oschina.net/oscnet/up-f1fd681cc9d295db74e85ad6d2fe4389454.png"/></td>
97
+        <td><img src="https://oscimg.oschina.net/oscnet/up-c195234bbcd30be6927f037a6755e6ab69c.png"/></td>
98
+    </tr>
99
+    <tr>
100
+        <td><img src="https://oscimg.oschina.net/oscnet/b6115bc8c31de52951982e509930b20684a.jpg"/></td>
101
+        <td><img src="https://oscimg.oschina.net/oscnet/up-6d73c2140ce694e3de4c05035fdc1868d4c.png"/></td>
102
+    </tr>
103
+</table>
104
+
105
+
106
+## 若依微服务交流群
107
+
108
+QQ群: [![加入QQ群](https://img.shields.io/badge/42799195-blue.svg)](https://jq.qq.com/?_wv=1027&k=yqInfq0S) 点击按钮入群。