first commit

README.md

@@ -0,0 +1,135 @@
+<p align="center">
+ <img src="https://img.shields.io/badge/Pig-3.9-success.svg" alt="Build Status">
+ <img src="https://img.shields.io/badge/Spring%20Cloud-2025-blue.svg" alt="Coverage Status">
+ <img src="https://img.shields.io/badge/Spring%20Boot-3.5-blue.svg" alt="Downloads">
+ <img src="https://img.shields.io/badge/Vue-3.5-blue.svg" alt="Downloads">
+ <img src="https://img.shields.io/github/license/pig-mesh/pig"/>
+ <img src="https://gitcode.com/pig-mesh/pig/star/badge.svg"/>
+</p>
+
+## 系统说明
+
+- 基于 Spring Cloud 、Spring Boot、 OAuth2 的 RBAC **企业快速开发平台**， 同时支持微服务架构和单体架构
+- 提供对 Spring Authorization Server 生产级实践，支持多种安全授权模式
+- 提供对常见容器化方案支持 Kubernetes、Rancher2 、Kubesphere、EDAS、SAE 支持
+
+#### 使用文档
+
+PIG 提供了详尽的部署文档 👉 [wiki.pig4cloud.com](https://wiki.pig4cloud.com)，涵盖开发环境配置、服务端启动、前端运行等关键步骤。
+
+重要的事情说三遍：
+
+- 🔥 [ 配套文档 wiki.pig4cloud.com](https://wiki.pig4cloud.com)
+- 🔥 [ 配套文档 wiki.pig4cloud.com](https://wiki.pig4cloud.com)
+- 🔥 [ 配套文档 wiki.pig4cloud.com](https://wiki.pig4cloud.com)
+
+#### 其他产品
+
+- 👉🏻 [PIGX 在线体验](http://home.pig4cloud.com:38081)
+
+- 👉🏻 [自研BPMN工作流引擎](http://home.pig4cloud.com:38082)
+
+- 👉🏻 [大模型 RAG 知识库](http://home.pig4cloud.com:38083)
+
+## 微信群 [禁广告]
+
+<img src='https://minio.pigx.vip/oss/202412/1735262426.png' alt='1735262426'/>
+
+## 快速开始
+
+#### Docker 快速体验
+
+```shell
+# 可用内存大于4G
+curl -o docker-compose.yaml https://try.pig4cloud.com
+# 等待5分钟
+docker compose up
+```
+
+### 核心依赖
+
+| 依赖                          | 版本   |
+|-----------------------------|------|
+| Spring Boot                 | 3.5  |
+| Spring Cloud                | 2025 |
+| Spring Cloud Alibaba        | 2023 |
+| Spring Authorization Server | 1.5  |
+| Mybatis Plus                | 3.5  |
+| Vue                         | 3.5  |
+| Element Plus                | 2.7  |
+
+### 模块说明
+
+```lua
+pig-ui  -- https://gitee.com/log4j/pig-ui
+
+pig
+├── pig-boot -- 单体模式启动器[9999]
+├── pig-auth -- 授权服务提供[3000]
+└── pig-common -- 系统公共模块
+     ├── pig-common-bom -- 全局依赖管理控制
+     ├── pig-common-core -- 公共工具类核心包
+     ├── pig-common-datasource -- 动态数据源包
+     ├── pig-common-log -- 日志服务
+     ├── pig-common-oss -- 文件上传工具类
+     ├── pig-common-mybatis -- mybatis 扩展封装
+     ├── pig-common-seata -- 分布式事务
+     ├── pig-common-security -- 安全工具类
+     ├── pig-common-swagger -- 接口文档
+     ├── pig-common-feign -- feign 扩展封装
+     └── pig-common-xss -- xss 安全封装
+├── 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-quartz -- 定时任务管理台 [5007]
+```
+
+## 免费公开课
+
+<table>
+  <tr>
+    <td><a href="https://www.bilibili.com/video/av45084065" target="_blank"><img src="https://foruda.gitee.com/images/1731647304254897555/88a9c2fa_441246.jpeg"></a></td>
+    <td><a href="https://www.bilibili.com/video/av77344954" target="_blank"><img src="https://foruda.gitee.com/images/1731647324953921510/39689640_441246.jpeg"></a></td>
+  </tr>
+    <tr>
+    <td><a href="https://www.bilibili.com/video/BV1J5411476V" target="_blank"><img src="https://foruda.gitee.com/images/1731647357502030768/7f31f392_441246.jpeg"></a></td>
+    <td><a href="https://www.bilibili.com/video/BV14p4y197K5" target="_blank"><img src="https://foruda.gitee.com/images/1731647375444479120/2b8fd494_441246.jpeg"></a></td>
+  </tr>
+</table>
+
+## 开源共建
+
+### 开源协议
+
+pig 开源软件遵循 [Apache 2.0 协议](https://www.apache.org/licenses/LICENSE-2.0.html)。
+允许商业使用，但务必保留类作者、Copyright 信息。
+
+![](https://foruda.gitee.com/images/1731647419204307063/91217172_441246.jpeg)
+
+### 其他说明
+
+1. 欢迎提交 [PR](https://dwz.cn/2KURd5Vf)，注意对应提交对应 `dev` 分支
+   代码规范 [spring-javaformat](https://github.com/spring-io/spring-javaformat)
+
+   <details>
+    <summary>代码规范说明</summary>
+
+    1. 由于 <a href="https://github.com/spring-io/spring-javaformat" target="_blank">spring-javaformat</a>
+       强制所有代码按照指定格式排版，未按此要求提交的代码将不能通过合并（打包）
+    2. 如果使用 IntelliJ IDEA
+       开发，请安装自动格式化软件 <a href="https://repo1.maven.org/maven2/io/spring/javaformat/spring-javaformat-intellij-idea-plugin/" target="_blank">
+       spring-javaformat-intellij-idea-plugin</a>
+    3. 其他开发工具，请参考 <a href="https://github.com/spring-io/spring-javaformat" target="_blank">
+       spring-javaformat</a>
+       说明，或`提交代码前`在项目根目录运行下列命令（需要开发者电脑支持`mvn`命令）进行代码格式化
+       ```
+       mvn spring-javaformat:apply
+       ```
+   </details>
+
+2. 欢迎提交 [issue](https://gitee.com/log4j/pig/issues)，请写清楚遇到问题的原因、开发环境、复显步骤。