diff --git a/docs/module/auth/README.md b/docs/module/auth/README.md index c356f9e..79f5193 100644 --- a/docs/module/auth/README.md +++ b/docs/module/auth/README.md @@ -1,2 +1,10 @@ # 授权服务模块 -为整个集群提供授权登录服务,先阶段实现账号密码登录,后续可以扩展实现微信登录,微信扫码登录,QQ等第三方登录方式 +## 服务简介 +授权登录服务是集群权限授权的入口,集群中的所有授权请求读应该在当前服务进行实现. + +## 提供服务 +- 验证码获取 +- 账号密码登录 +- 微信小程序授权登录(规划中) +- 用户登录后用户权限标识和用户信息获取 + diff --git a/docs/module/umps/README.md b/docs/module/umps/README.md index 5816117..61f1697 100644 --- a/docs/module/umps/README.md +++ b/docs/module/umps/README.md @@ -1,8 +1,15 @@ # 通用用户权限管理模块 -通用用户权限管理模块主要集成用户管理,角色管理,菜单管理,部门管理,岗位管理,字典管理,字典类型配置,在线用户管理等 +## 服务简介 +通用用户权限模块为集群中的核心,集群中的系统基础服务的在此实现 -## umps-api rpc api服务模块 -为集群远程rpc 实体对象和fegin 的远程接口调用 +## 提供服务 +- 用户管理 +- 角色管理 +- 菜单管理 +- 部门管理 +- 岗位管理 +- 字典管理 +- 字典类型配置 +- 在线用户管理 +- fegin rpc远程调用api服务 -## umps-biz 业务服务模块 -提供真实的业务需求,对用户管理,角色管理,菜单管理,部门管理,岗位管理,字典管理,字典类型配置,在线用户管理等服务的具体实现 diff --git a/docs/module/visual/README.md b/docs/module/visual/README.md index 7750804..fcb7c1b 100644 --- a/docs/module/visual/README.md +++ b/docs/module/visual/README.md @@ -8,7 +8,9 @@ - sentinel-dashboard-pro -- sentinel监控面板,配置规则同步到nacos管理 ## code-gen(正在开发) -提供数据库数据源的配置,支持mysql,MariaDB,以及oracle三种数据库 +为提高集群编码效率,可以快速生成crud后端代码和配套的前端页面代码,以数据库元数据作为数据基础是. + +在集群模式下每一个服务所在的数据库地址不同,数据库不同,甚至数据库类型不同,所以提供数据库数据源的配置,支持mysql,MariaDB,以及oracle三种数据库 支持可视化的代码生成配置,并且根据数据源不同生成对应数据库的标准curd代码 diff --git a/docs/wiki/back-build/README.md b/docs/wiki/back-build/README.md index f30e9d4..062a126 100644 --- a/docs/wiki/back-build/README.md +++ b/docs/wiki/back-build/README.md @@ -1,5 +1,5 @@ # 后端部署 ## 需要部署的内容 -- auth -- gateway -- umps +- auth 权限认证模块 +- gateway 网关服务模块 +- umps 系统用户权限管理模块 diff --git a/docs/wiki/introduce/README.md b/docs/wiki/introduce/README.md index bfd470d..1266d6d 100644 --- a/docs/wiki/introduce/README.md +++ b/docs/wiki/introduce/README.md @@ -1 +1,36 @@ -# 介绍 +# 项目简介 + +## 项目背景 +互联网对高并发集群的需求愈发的变大,spring boot 的单体应用已经不满足于现在复杂的业务需求,spring cloud逐渐成为高并发集群的标杆,学习spring cloud也刻不容缓, +该项目是在学习了spring cloud中各种组件之后,为锻炼自己的集群能力,并且自己也想做一套集群的基础权限管理系统。 + +该集群为一套基础的权限管理系统,主导权限控制,权限管理等核心功能,并且配合配合visual(图形化管理模块)对集群的资源进行更方便的关系,提高软件开发的效率。 + +## 系统说明 +- 基于 Spring Cloud 2021 、Spring Boot 2.7、 Spring Security 的权限管理系统 +- 采用前后端分离的模式,前端(基于 Security-React, Security-Vue) +- 注册中心,配置中心使用Nacos, +- 权限认证使用Spring Security + Redis +- 流量控制使用Sentinel +- gitea+drone+harbor+rancher全套部署流程 + +## 核心依赖 + +| 依赖 | 版本 | +|----------------------|------------| +| Spring Boot | 2.7.5 | +| Spring Cloud | 2021.0.5 | +| Spring Cloud Alibaba | 2021.0.4.0 | +| Mybatis | 3.5.2 | +| Vue | 3.1.3 | +| React | 3.1.3 | + +## 软件相关架构 +![](./jiagou.png) + +- 集群通过gateway作为集群的唯一入口,然后访问到授权中心等其他服务,服务之间授权则使用`@inner`注解加上aop标识 + +## CI/CD +![](./cicd.png) + + diff --git a/docs/wiki/introduce/cicd.png b/docs/wiki/introduce/cicd.png new file mode 100644 index 0000000..3bbd4bd Binary files /dev/null and b/docs/wiki/introduce/cicd.png differ diff --git a/docs/wiki/introduce/jiagou.png b/docs/wiki/introduce/jiagou.png new file mode 100644 index 0000000..ca7f46a Binary files /dev/null and b/docs/wiki/introduce/jiagou.png differ