README.md 7.6 KB
Newer Older
twelvet's avatar
twelvet 已提交
1 2
[中文](https://github.com/twelvet-s/twelvet/blob/master/README.md) | [English](https://github.com/twelvet-s/twelvet/blob/master/README_EN.md)

twelvet's avatar
twelvet 已提交
3
# 🚀twelvet
twelvet's avatar
mq  
twelvet 已提交
4

twelvet's avatar
README  
twelvet 已提交
5
[![AUR](https://img.shields.io/github/license/twelvet-s/twelvet)](https://github.com/twelvet-s/twelvet/blob/master/LICENSE)
twelvet's avatar
twelvet 已提交
6
[![](https://img.shields.io/badge/Author-TwelveT-orange.svg)](https://twelvet.cn)
twelvet's avatar
twelvet 已提交
7
[![](https://img.shields.io/badge/version-2.7.5-success)](https://github.com/twelvet-s/twelvet)
twelvet's avatar
README  
twelvet 已提交
8 9
[![GitHub stars](https://img.shields.io/github/stars/twelvet-s/twelvet.svg?style=social&label=Stars)](https://github.com/twelvet-s/twelvet/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/twelvet-s/twelvet.svg?style=social&label=Fork)](https://github.com/twelvet-s/twelvet/network/members)
twelvet's avatar
mq  
twelvet 已提交
10 11 12
[![star](https://gitee.com/twelvet/twelvet/badge/star.svg?theme=white)](https://gitee.com/twelvet/twelvet/stargazers)
[![fork](https://gitee.com/twelvet/twelvet/badge/fork.svg?theme=white)](https://gitee.com/twelvet/twelvet/members)

twelvet's avatar
twelvet 已提交
13
### 此版本将跟随Spring Boot的脚步于2023-11-18停止维护,将不会再有新的特性更新(依旧进行BUG修复),请尽快升级到Spring Boot3分支
twelvet's avatar
twelvet 已提交
14

twelvet's avatar
mq  
twelvet 已提交
15 16
一款基于Spring Cloud Alibaba的权限管理系统,集成市面上流行库,可以作用为快速开发的一个框架使用

twelvet's avatar
twelvet 已提交
17
一套以微服务架构的脚手架,使用Spring Cloud Alibaba系列进行架构,学习并了解它将能快速掌握微服务核心基础。
twelvet's avatar
mq  
twelvet 已提交
18 19
此项目是为了减少业务代码的重复轮子,它具有一个系统该有的通用性核心业务代码,无论是微服务还是单体,都是通用的业务
但更多的,是为了学习微服务的理念以及开发 您可以使用它进行网站管理后台,网站会员中心,CMS,CRM,OA等待系统的开发,
twelvet's avatar
twelvet 已提交
20
当然,不仅仅是一些小系统,我们可以生产更多的服务模块,不断完善项目。
twelvet's avatar
mq  
twelvet 已提交
21 22 23 24 25 26 27 28

系统初心是为了能够更快地完成业务的需求,带来更好的体验、更多的时间。它将会用于孵化一些实用的功能点。
我们希望它们是轻量级,可移植性高的功能插件。

同时,我们更希望广大开发者能在其中更快地获得更好的解决方案、尽量降低我们的学习成本。
由此,我们应当把更多的时间投入到其它更有意义的事情当中,我们深知知识的重要性,但,并不希望仅拥有单一”知识“。
去感受/关爱更多光彩,无论人、事、物,它们也将成为你最好的灵感。

twelvet's avatar
README  
twelvet 已提交
29
后端源码:https://github.com/twelvet-s/twelvet
twelvet's avatar
mq  
twelvet 已提交
30

twelvet's avatar
README  
twelvet 已提交
31
前端源码:https://github.com/twelvet-s/twelvet-ui
twelvet's avatar
mq  
twelvet 已提交
32

twelvet's avatar
twelvet 已提交
33
技术文档:https://twelvet.cn/docs/
twelvet's avatar
README  
twelvet 已提交
34

twelvet's avatar
twelvet 已提交
35
官方博客:https://twelvet.cn
twelvet's avatar
README  
twelvet 已提交
36

twelvet's avatar
twelvet 已提交
37 38 39 40 41 42 43 44 45
## 🍎 分支说明

| 分支                   | 说明                                                                 |
|----------------------|--------------------------------------------------------------------|
| master               | java8 + springboot 2.7.x + springcloud 2021 + spring cloud alibaba |
| master-boot-3        | java17 + springboot 3.x + springcloud 2022 + spring cloud alibaba  |
| spring-cloud-tencent | java17 + springboot 3.x + springcloud 2022 + spring cloud tencent  |

## 项目结构
twelvet's avatar
mq  
twelvet 已提交
46 47 48 49 50

~~~
com.twelvet     
├── twelvet-ui              // 前端框架 [80]
├── twelvet-gateway         // 网关模块 [88]
twelvet's avatar
README  
twelvet 已提交
51
├── twelvet-nacos           // nacos [8848]
twelvet's avatar
mq  
twelvet 已提交
52 53
├── twelvet-auth            // 认证中心 [8888]
├── twelvet-api             // 接口模块
twelvet's avatar
README  
twelvet 已提交
54 55 56
│       └── twelvet-api-system                             // 系统接口
│       └── twelvet-api-dfs                                // DFS接口
│       └── twelvet-api-job                                // 定时任务接口
twelvet's avatar
REDME  
twelvet 已提交
57
├── twelvet-framework       // 核心模块
twelvet's avatar
mq  
twelvet 已提交
58 59
│       └── twelvet-framework-core                         // 核心模块
│       └── twelvet-framework-log                          // 日志记录
twelvet's avatar
v2.0.0  
twelvet 已提交
60 61 62
│       └── twelvet-framework-datascope                    // 数据权限
│       └── twelvet-framework-jdbc                         // jdbc
│       └── twelvet-framework-swagger                      // swagger文档
twelvet's avatar
mq  
twelvet 已提交
63 64 65 66 67
│       └── twelvet-framework-redis                        // 缓存服务
│       └── twelvet-framework-security                     // 安全模块
│       └── twelvet-framework-utils                        // 工具模块
├── twelvet-server         // 业务模块
│       └── twelvet-server-system                          // 系统模块 [8081]
twelvet's avatar
REDME  
twelvet 已提交
68
│       └── twelvet-server-job                             // 定时任务 [8082]
twelvet's avatar
README  
twelvet 已提交
69
│       └── twelvet-server-dfs                             // DFS服务 [8083]
twelvet's avatar
REDME  
twelvet 已提交
70 71
│       └── twelvet-server-gen                             // 代码生成 [8084]
├── twelvet-visual        // 图形化管理模块
twelvet's avatar
README  
twelvet 已提交
72 73
|       └── twelvet-visual-sentinel                        // sentinel [8101]
│       └── twelvet-visual-monitor                         // 监控中心 [8102]
twelvet's avatar
mq  
twelvet 已提交
74 75 76
├──pom.xml                // 公共依赖
~~~

twelvet's avatar
README  
twelvet 已提交
77
## 内置功能
twelvet's avatar
mq  
twelvet 已提交
78 79 80 81 82 83 84 85

1. 用户管理:用户是系统操作者,该功能主要完成系统用户配置。
2. 部门管理:配置系统组织机构(公司、部门、小组),树结构展现支持数据权限。
3. 岗位管理:配置系统用户所属担任职务。
4. 菜单管理:配置系统菜单,操作权限,按钮权限标识等。
5. 角色管理:角色菜单权限分配、设置角色按机构进行数据范围权限划分。
6. 字典管理:对系统中经常使用的一些较为固定的数据进行维护。
7. 参数管理:对系统动态配置常用参数。
twelvet's avatar
README  
twelvet 已提交
86
8. 异步:登录日志/系统操作日志/系统登录日志记记录和查询。
twelvet's avatar
README  
twelvet 已提交
87 88 89 90 91 92
9. 定时任务:在线(添加、修改、删除)任务调度包含执行结果日志。
10. 代码生成:一键生成CRUD前后端代码,为业务开发提供更快的速度。
11. 服务监控:监视当前系统CPU、内存、磁盘、堆栈等相关信息。
12. 连接池监视:监视当前系统数据库连接池状态,可进行分析SQL找出系统性能瓶颈。
13. 分布式文件储存。
14. Swagger网关聚合文档。
twelvet's avatar
README  
twelvet 已提交
93 94
15. Sentinel限流中心。
16. Nacos注册 + 配置中心。
twelvet's avatar
mq  
twelvet 已提交
95 96 97 98 99

## 演示图

<table>
    <tr>
twelvet's avatar
twelvet 已提交
100 101
        <td><img src="https://twelvet.cn/assets/images/twelvet/1.png"/></td>
        <td><img src="https://twelvet.cn/assets/images/twelvet/2.png"/></td>
twelvet's avatar
mq  
twelvet 已提交
102 103
    </tr>
    <tr>
twelvet's avatar
twelvet 已提交
104 105
        <td><img src="https://twelvet.cn/assets/images/twelvet/3.png"/></td>
        <td><img src="https://twelvet.cn/assets/images/twelvet/4.png"/></td>
twelvet's avatar
mq  
twelvet 已提交
106 107
    </tr>
    <tr>
twelvet's avatar
twelvet 已提交
108 109
        <td><img src="https://twelvet.cn/assets/images/twelvet/5.png"/></td>
        <td><img src="https://twelvet.cn/assets/images/twelvet/6.png"/></td>
twelvet's avatar
mq  
twelvet 已提交
110 111 112 113 114 115 116
    </tr>
</table>

## 在线体验

- admin/123456

twelvet's avatar
twelvet 已提交
117
演示地址:[https://cloud.twelvet.cn](https://cloud.twelvet.cn)
twelvet's avatar
mq  
twelvet 已提交
118

twelvet's avatar
README  
twelvet 已提交
119
## 架构图
twelvet's avatar
twelvet 已提交
120

twelvet's avatar
twelvet 已提交
121
<img src="https://twelvet.cn/assets/images/twelvet/map.png"/>
twelvet's avatar
README  
twelvet 已提交
122

twelvet's avatar
twelvet 已提交
123 124
## ✈️✈️✈️快速启动微服务

twelvet's avatar
twelvet 已提交
125
内存 > 16
twelvet's avatar
twelvet 已提交
126
需要自行安装maven、docker、docker-compose、node、yarn
twelvet's avatar
twelvet 已提交
127

twelvet's avatar
twelvet 已提交
128
```shell
twelvet's avatar
twelvet 已提交
129
# mvn
twelvet's avatar
twelvet 已提交
130
mvn clean && mvn install
twelvet's avatar
twelvet 已提交
131
# 进入脚本目录
twelvet's avatar
twelvet 已提交
132
cd ./docker
twelvet's avatar
前端  
twelvet 已提交
133
# 可执行权限
twelvet's avatar
twelvet 已提交
134 135
chmod 751 deploy.sh
# 执行启动(按需执行参数,[init|port|base|server|stop|rm])
twelvet's avatar
前端  
twelvet 已提交
136 137 138 139 140 141
# 初始化
./deploy.sh init
# 基础服务
./deploy.sh base
# 启动twelvet
./deploy.sh server
twelvet's avatar
nginx  
twelvet 已提交
142 143
# 启动UI
./deploy.sh nginx
twelvet's avatar
twelvet 已提交
144 145
```

twelvet's avatar
mq  
twelvet 已提交
146 147 148
## TwelveT微服务交流群

QQ群: [![加入QQ群](https://img.shields.io/badge/985830229-blue.svg)](https://jq.qq.com/?_wv=1027&k=cznM6Q00) 点击按钮入群。
twelvet's avatar
twelvet 已提交
149 150

## 🤝鸣谢
twelvet's avatar
twelvet 已提交
151
感谢jetbrains提供的许可证[![jetbrains](https://cloud.twelvet.cn/jetbrains.png)](https://www.jetbrains.com?from=https://github.com/twelvet-s/twelvet)