# Ukulele-Cloud-Nacos

**Repository Path**: timingtech/ukulele-cloud-nacos

## Basic Information

- **Project Name**: Ukulele-Cloud-Nacos
- **Description**: 本项目的创建旨在打造一个企业级微服务全栈开发框架，为中小企业降低开发难度。

Ukulele是一个乐器，它小巧、携带方便，声音好听可爱，能够激发节奏潜能。只要它在手中，没有你不会弹的歌。这正如我想要打造的企业级全站开发框架一样：小巧，易构建，对用户友好，涵盖绝大数企业开发需求。因此我将框架命名为 Ukulele.
- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: master
- **Homepage**: http://timingtech.top/
- **GVP Project**: No

## Statistics

- **Stars**: 31
- **Forks**: 5
- **Created**: 2021-09-08
- **Last Updated**: 2026-01-07

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 分支说明
* master：主分支

# 主要特性
* 多租户
* RBAC & RBAC
* Spring Security 与 Spring OAuth2 Authorization Server

# 技术选型
* 核心框架：SpringBoot3、Spring Cloud Alibaba
* 注册中心：Nacos
* 网关： Spring Cloud Gateway
* 安全框架：Spring Security、Jwt、Spring Security OAuth2
* 文档：SpringDoc
* 中间件：Redis、Rabbitmq
* 持久层框架：Mybatis、MyBatis-Plus
* 工具：Lombok
* JDK版本：Java17
* 数据库：mysql5.7+
* 前端框架： Angular17、Ng-Alain17

# 模块说明
* ukulele-auth：鉴权模块，登录接口，token发放
* ukulele-gateway：网关，校验token、接口权限等
* ukulele-log：日志，记录请求日志
* ukulele-portal：用户RBAC配置，字典，参数，图标等配置
* ukulele-user：用户中心
* ukulele-share：公共模块

# 使用说明

1. clone并mvn install基础框架：[ukulele-master](https://gitee.com/timingtech/ukulele-master)
2. clone并mvn install数据模块：[ukulele-data](https://gitee.com/timingtech/ukulele-data)
3. clone接口模块：[ukulele-facade](https://gitee.com/timingtech/ukulele-facade)
4. 切换至feign分支，mvn install
5. clone本项目
6. 启动Mysql,并导入数据库,脚本在database文件夹下，分4个库
7. 启动nacos,并导入nacos配置
8. 启动redis、rabbimq
9. 修改各个服务中的脚本使之与自己的环境匹配[可选]
10. 分别启动各个服务
11. 准备一个域名(本实例使用的域名为: www.ukulele.com), 并用[SwitchHost](https://github.com/oldj/SwitchHosts/releases)等工具添加至本机host文件中
11. 访问各个服务接口文档页面：ip:port/上下文/swagger-ui.html

# 架构
![Structure](/screenshots/structure.png)

# 前端项目地址

1. Angular版本：[Ukulele-Ng-Alain](https://gitee.com/timingtech/Ukulele-Ng-Alain)
2. Vue3版本：[Ukulele-Vue-Ant](https://gitee.com/timingtech/ukulele-vue-ant)

# 接口文档
* 网关服务
![网关服务](/screenshots/document-gateway.jpg)
* 认证授权
![网关服务](/screenshots/service-auth.jpg)
* 用户服务
![用户中心](/screenshots/service-user.jpg)
* 日志服务
![日志服务](/screenshots/service-log.jpg)
* 系统服务
![系统服务](/screenshots/service-portal.jpg)

# 接口文档鉴权
* 1. 访问网关服务
![访问网关](/screenshots/auth1.jpg)
* 2. 切换要访问的服务，点击**Authorize**按钮
![点击授权](/screenshots/auth2.jpg)
* 2. 跳转至授权确认界面（登录，授权）
![授权成功](/screenshots/auth3.jpg)

# 系统截图

* 登录
  ![用户名密码登录](/screenshots/login-captcha.png)
  ![手机验证码登录](/screenshots/login-phone.png)
* 用户管理
  ![用户管理](/screenshots/user.png)
* 角色管理
  ![角色管理](/screenshots/role.png)
* 菜单管理
  ![菜单管理](/screenshots/menu.png)
* 资源管理
  ![资源管理](/screenshots/resource.png)
* 角色菜单
  ![角色菜单](/screenshots/role-menu.png)
* 角色资源
  ![角色资源](/screenshots/role-resource.png)
* 用户角色
  ![用户角色](/screenshots/user-role.png)
* 字典管理
  ![字典管理](/screenshots/dict.png)
* 参数管理
  ![参数管理](/screenshots/param.png)
* SCOPE管理
  ![SCOPE管理](/screenshots/scope.png)
* Auth客户端管理
  ![Auth客户端管理](/screenshots/client.png)
* 用户中心
  ![用户中心](/screenshots/profile.jpg)
  ![用户中心](/screenshots/profile-security.jpg)
  ![用户中心](/screenshots/profile-auth.jpg)

**已经看到这里了，留个star呗**