|
1 | | -<p align="center"> |
2 | | - <img src="https://img.shields.io/badge/Pig-3.8-success.svg" alt="Build Status"> |
3 | | - <img src="https://img.shields.io/badge/Spring%20Cloud-2021-blue.svg" alt="Coverage Status"> |
4 | | - <img src="https://img.shields.io/badge/Spring%20Boot-2.7-blue.svg" alt="Downloads"> |
5 | | - <img src="https://img.shields.io/badge/Vue-3.2-blue.svg" alt="Downloads"> |
6 | | - <img src="https://img.shields.io/github/license/pig-mesh/pig"/> |
7 | | -</p> |
| 1 | +## 安全警告 |
8 | 2 |
|
9 | | -## 系统说明 |
| 3 | +您选择的 JDK8+Spring Boot 2 已被Spring官方停止维护,存在官方未修复的安全漏洞。 为保障系统安全,强烈建议选择JDK17+Spring Boot 3,获取最新安全更新和功能支持。 |
10 | 4 |
|
11 | | -- 基于 Spring Cloud 2021 、Spring Boot 2.7、 OAuth2 的 RBAC **权限管理系统** |
12 | | -- 基于数据驱动视图的理念封装 element-plus,即使没有 vue 的使用经验也能快速上手 |
13 | | -- 提供对常见容器化支持 Docker、Kubernetes、Rancher2 支持 |
14 | | -- 提供 lambda 、stream api 、webflux 的生产实践 |
15 | | - |
16 | | -## 文档视频 |
17 | | - |
18 | | -[ 🚀🚀🚀 低代码数据可视化](http://datav.pig4cloud.com) |
19 | | - |
20 | | -[ 配套文档 wiki.pig4cloud.com](https://wiki.pig4cloud.com) |
21 | | - |
22 | | -[ 配套视频 tv.pig4cloud.com](https://www.bilibili.com/video/BV12t411B7e9) |
23 | | - |
24 | | -[PIGX 在线体验 pigx.pigx.top](http://pigx.pigx.top) |
25 | | - |
26 | | -[产品白皮书 paper.pig4cloud.com](https://paper.pig4cloud.com) |
27 | | - |
28 | | -## 微信群 [禁广告] |
29 | | - |
30 | | - |
31 | | - |
32 | | -## 快速开始 |
33 | | - |
34 | | -### 分支说明 |
35 | | - |
36 | | -- master: java8 + springboot 2.7 + springcloud 2021 |
37 | | -- jdk17: java17 + springboot 3.1 + springcloud 2022 |
38 | | - |
39 | | -### 核心依赖 |
40 | | - |
41 | | -| 依赖 | 版本 | |
42 | | -|-----------------------------|------------| |
43 | | -| Spring Boot | 2.7.18 | |
44 | | -| Spring Cloud | 2021.0.8 | |
45 | | -| Spring Cloud Alibaba | 2021.0.6.1 | |
46 | | -| Spring Authorization Server | 0.4.4 | |
47 | | -| Mybatis Plus | 3.5.7 | |
48 | | -| hutool | 5.8.29 | |
49 | | - |
50 | | -### 模块说明 |
51 | | - |
52 | | -```lua |
53 | | -pig-ui -- https://gitee.com/log4j/pig-ui |
54 | | - |
55 | | -pig |
56 | | -├── pig-auth -- 授权服务提供[3000] |
57 | | -├── pig-boot -- 单体模式启动[9999] |
58 | | -└── pig-common -- 系统公共模块 |
59 | | - ├── pig-common-bom -- 全局依赖管理控制 |
60 | | - ├── pig-common-core -- 公共工具类核心包 |
61 | | - ├── pig-common-datasource -- 动态数据源包 |
62 | | - ├── pig-common-job -- xxl-job 封装 |
63 | | - ├── pig-common-log -- 日志服务 |
64 | | - ├── pig-common-oss -- 文件上传工具类 |
65 | | - ├── pig-common-mybatis -- mybatis 扩展封装 |
66 | | - ├── pig-common-seata -- 分布式事务 |
67 | | - ├── pig-common-security -- 安全工具类 |
68 | | - ├── pig-common-swagger -- 接口文档 |
69 | | - ├── pig-common-feign -- feign 扩展封装 |
70 | | - └── pig-common-xss -- xss 安全封装 |
71 | | -├── pig-register -- Nacos Server[8848] |
72 | | -├── pig-gateway -- Spring Cloud Gateway网关[9999] |
73 | | -└── pig-upms -- 通用用户权限管理模块 |
74 | | - └── pig-upms-api -- 通用用户权限管理系统公共api模块 |
75 | | - └── pig-upms-biz -- 通用用户权限管理系统业务处理模块[4000] |
76 | | -└── pig-visual |
77 | | - └── pig-monitor -- 服务监控 [5001] |
78 | | - ├── pig-codegen -- 图形化代码生成 [5002] |
79 | | - └── pig-quartz -- 定时任务管理台 [5007] |
80 | | -``` |
81 | | - |
82 | | -### 本地开发 运行 |
83 | | - |
84 | | -pig 提供了详细的[部署文档 wiki.pig4cloud.com](https://www.yuque.com/pig4cloud/pig/vsdox9),包括开发环境安装、服务端代码运行、前端代码运行等。 |
85 | | - |
86 | | -请务必**完全按照**文档部署运行章节 进行操作,减少踩坑弯路!! |
87 | | - |
88 | | - |
89 | | -### Docker 运行 |
90 | | - |
91 | | -``` |
92 | | -# 下载并运行服务端代码 |
93 | | -git clone https://gitee.com/log4j/pig.git |
94 | | -
|
95 | | -cd pig && mvn clean install && docker-compose up -d |
96 | | -
|
97 | | -# 下载并运行前端UI |
98 | | -git clone https://gitee.com/log4j/pig-ui.git |
99 | | -
|
100 | | -cd pig-ui && npm install -g cnpm --registry=https://registry.npm.taobao.org |
101 | | -
|
102 | | -
|
103 | | -cnpm install && cnpm run build:docker && cd docker && docker-compose up -d |
104 | | -``` |
105 | | - |
106 | | -## 免费公开课 |
107 | | - |
108 | | -<table> |
109 | | - <tr> |
110 | | - <td><a href="https://www.bilibili.com/video/av45084065" target="_blank"><img src="https://minio.pigx.top/oss/1655474345.jpg"></a></td> |
111 | | - <td><a href="https://www.bilibili.com/video/av77344954" target="_blank"><img src="https://minio.pigx.top/oss/1656837143.jpg"></a></td> |
112 | | - </tr> |
113 | | - <tr> |
114 | | - <td><a href="https://www.bilibili.com/video/BV1J5411476V" target="_blank"><img src="https://minio.pigx.top/oss/1655474369.jpg"></a></td> |
115 | | - <td><a href="https://www.bilibili.com/video/BV14p4y197K5" target="_blank"><img src="https://minio.pigx.top/oss/1655474381.jpg"></a></td> |
116 | | - </tr> |
117 | | -</table> |
118 | | - |
119 | | -## 开源共建 |
120 | | - |
121 | | -### 开源协议 |
122 | | - |
123 | | -pig 开源软件遵循 [Apache 2.0 协议](https://www.apache.org/licenses/LICENSE-2.0.html)。 |
124 | | -允许商业使用,但务必保留类作者、Copyright 信息。 |
125 | | - |
126 | | - |
127 | | - |
128 | | -### 其他说明 |
129 | | - |
130 | | -1. 欢迎提交 [PR](https://dwz.cn/2KURd5Vf),注意对应提交对应 `dev` 分支 |
131 | | - 代码规范 [spring-javaformat](https://github.com/spring-io/spring-javaformat) |
132 | | - |
133 | | - <details> |
134 | | - <summary>代码规范说明</summary> |
135 | | - |
136 | | - 1. 由于 <a href="https://github.com/spring-io/spring-javaformat" target="_blank">spring-javaformat</a> |
137 | | - 强制所有代码按照指定格式排版,未按此要求提交的代码将不能通过合并(打包) |
138 | | - 2. 如果使用 IntelliJ IDEA |
139 | | - 开发,请安装自动格式化软件 <a href="https://repo1.maven.org/maven2/io/spring/javaformat/spring-javaformat-intellij-idea-plugin/" target="_blank"> |
140 | | - spring-javaformat-intellij-idea-plugin</a> |
141 | | - 3. 其他开发工具,请参考 <a href="https://github.com/spring-io/spring-javaformat" target="_blank"> |
142 | | - spring-javaformat</a> |
143 | | - 说明,或`提交代码前`在项目根目录运行下列命令(需要开发者电脑支持`mvn`命令)进行代码格式化 |
144 | | - ``` |
145 | | - mvn spring-javaformat:apply |
146 | | - ``` |
147 | | - </details> |
148 | | -
|
149 | | -2. 欢迎提交 [issue](https://gitee.com/log4j/pig/issues),请写清楚遇到问题的原因、开发环境、复显步骤。 |
| 5 | +继续使用过时版本可能导致安全风险,本团队不对由此产生的问题负责。 选择使用即表示已知悉并接受相关风险。 |
0 commit comments