README.md 5.0 KB
Newer Older
1
<p align="center">
L
Lht 已提交
2
 <img src="https://img.shields.io/badge/Pig-3.4-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/github/license/pig-mesh/pig"/>
6
</p>
7

8
## 系统说明
pig_冷冷's avatar
pig_冷冷 已提交
9

10
- 基于 Spring Cloud 2021 、Spring Boot 2.7、 OAuth2 的 RBAC **权限管理系统**
11 12 13
- 基于数据驱动视图的理念封装 element-ui,即使没有 vue 的使用经验也能快速上手
- 提供对常见容器化支持 Docker、Kubernetes、Rancher2 支持
- 提供 lambda 、stream api 、webflux 的生产实践
pig_冷冷's avatar
pig_冷冷 已提交
14

15 16
## 文档视频

17 18
[ 配套文档 wiki.pig4cloud.com](https://wiki.pig4cloud.com)

19
[ 配套视频 tv.pig4cloud.com](https://www.bilibili.com/video/BV12t411B7e9)
20 21 22 23 24 25 26

[PIGX 在线体验 pigx.pig4cloud.com](http://pigx.pig4cloud.com)

[产品白皮书 paper.pig4cloud.com](https://paper.pig4cloud.com)

## 微信群 [禁广告]

27
![](https://minio.pigx.vip/oss/1648184189.png)
28 29 30

## 快速开始

31
### 核心依赖
pig_冷冷's avatar
pig_冷冷 已提交
32

33 34
| 依赖                   | 版本         |
| ---------------------- |------------|
35
| Spring Boot            | 2.7.0      |
36 37 38 39
| Spring Cloud           | 2021.0.1   |
| Spring Cloud Alibaba   | 2021.0.1.0 |
| Spring Security OAuth2 | 2.3.6      |
| Mybatis Plus           | 3.5.1      |
40
| hutool                 | 5.8.0      |
41
| Avue                   | 2.6.18     |
pig_冷冷's avatar
pig_冷冷 已提交
42

43 44 45 46 47 48 49 50
### 模块说明

```lua
pig-ui  -- https://gitee.com/log4j/pig-ui

pig
├── pig-auth -- 授权服务提供[3000]
└── pig-common -- 系统公共模块
51
     ├── pig-common-bom -- 全局依赖管理控制
52 53 54 55 56
     ├── pig-common-core -- 公共工具类核心包
     ├── pig-common-datasource -- 动态数据源包
     ├── pig-common-job -- xxl-job 封装
     ├── pig-common-log -- 日志服务
     ├── pig-common-mybatis -- mybatis 扩展封装
57
     ├── pig-common-seata -- 分布式事务
58 59
     ├── pig-common-security -- 安全工具类
     ├── pig-common-swagger -- 接口文档
60
     ├── pig-common-feign -- feign 扩展封装
61 62 63 64 65 66 67 68 69 70 71
     └── pig-common-test -- oauth2.0 单元测试扩展封装
├── pig-register -- Nacos Server[8848]
├── pig-gateway -- Spring Cloud Gateway网关[9999]
└── pig-upms -- 通用用户权限管理模块
     └── pig-upms-api -- 通用用户权限管理系统公共api模块
     └── pig-upms-biz -- 通用用户权限管理系统业务处理模块[4000]
└── pig-visual
     └── pig-monitor -- 服务监控 [5001]
     ├── pig-codegen -- 图形化代码生成 [5002]
     ├── pig-sentinel-dashboard -- 流量高可用 [5003]
     └── pig-xxl-job-admin -- 分布式定时任务管理台 [5004]
72 73
```

74 75 76 77 78 79
### 本地开发 运行

pig 提供了详细的[部署文档 wiki.pig4cloud.com](https://www.yuque.com/pig4cloud/pig/vsdox9),包括开发环境安装、服务端代码运行、前端代码运行等。

请务必**完全按照**文档部署运行章节 进行操作,减少踩坑弯路!!

80 81
### 定制自己微服务

82
[PIG DIY](https://diy.pig4cloud.com)
83

84 85
[PIG ARCHETYPE](https://archetype.pig4cloud.com)

86
### Docker 运行
87

pig_冷冷's avatar
pig_冷冷 已提交
88
```
89 90
# 下载并运行服务端代码
git clone https://gitee.com/log4j/pig.git
pig_冷冷's avatar
pig_冷冷 已提交
91

92
cd pig && mvn clean install && docker-compose up -d
pig_冷冷's avatar
pig_冷冷 已提交
93

94 95
# 下载并运行前端UI
git clone https://gitee.com/log4j/pig-ui.git
pig_冷冷's avatar
pig_冷冷 已提交
96

97
cd pig-ui && npm install -g cnpm --registry=https://registry.npm.taobao.org
98

高吉策 已提交
99 100

cnpm install && cnpm run build:docker && cd docker && docker-compose up -d
101
```
102

103
## 免费公开课
pig_冷冷's avatar
pig_冷冷 已提交
104

105 106
<table>
  <tr>
107 108
    <td><a href="https://www.bilibili.com/video/av45084065" target="_blank"><img src="https://gitee.com/pig4cloud/oss/raw/master/2020-9/20200901133006.png"></a></td>
    <td><a href="https://www.bilibili.com/video/av77344954" target="_blank"><img src="https://gitee.com/pig4cloud/oss/raw/master/2020-9/20200901133059.png"></a></td>
109
  </tr>
pig_冷冷's avatar
pig_冷冷 已提交
110
    <tr>
111
    <td><a href="https://www.bilibili.com/video/BV1J5411476V" target="_blank"><img src="https://gitee.com/pig4cloud/oss/raw/master/2020-9/20200901133114.png"></a></td>
112
    <td><a href="https://www.bilibili.com/video/BV14p4y197K5" target="_blank"><img src="https://gitee.com/pig4cloud/oss/raw/master/2020-9/20200901133124.png"></a></td>
pig_冷冷's avatar
pig_冷冷 已提交
113
  </tr>
114
</table>
pig_冷冷's avatar
pig_冷冷 已提交
115

116 117 118 119 120 121 122
## 开源共建

### 开源协议

pig 开源软件遵循 [Apache 2.0 协议](https://www.apache.org/licenses/LICENSE-2.0.html)
允许商业使用,但务必保留类作者、Copyright 信息。

123 124
![](https://gitee.com/pig4cloud/oss/raw/master/2020-10-9/1602229452602-image.png)

125 126
### 其他说明

127 128
1. 欢迎提交 [PR](https://dwz.cn/2KURd5Vf),注意对应提交对应 `dev` 分支
   代码规范 [spring-javaformat](https://github.com/spring-io/spring-javaformat)
129 130

2. 欢迎提交 [issue](https://gitee.com/log4j/pig/issues),请写清楚遇到问题的原因、开发环境、复显步骤。
131

132
3. 联系作者 <a href="mailto:pig4cloud@qq.com">pig4cloud@qq.com</a>
133 134 135

[![Stargazers over time](https://whnb.wang/img/log4j/pig?e=604800)](https://whnb.wang/log4j/pig?e=604800)