From 2a73166770585d545ec1146c7739a7b15a4b0475 Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Sat, 28 Jun 2025 10:30:34 +0000 Subject: [PATCH] Update README.md --- README.md | 160 ++++++++++++++---------------------------------------- 1 file changed, 41 insertions(+), 119 deletions(-) diff --git a/README.md b/README.md index ef7216524..9de007b0a 100644 --- a/README.md +++ b/README.md @@ -1,135 +1,57 @@ -

- Build Status - Coverage Status - Downloads - Downloads - - -

+# Pig 微服务快速开发平台 ## 系统说明 +Pig 是一个基于 Spring Cloud Alibaba 的微服务快速开发平台，提供开箱即用的组件和模块化设计，适用于企业级应用开发。平台包含认证中心、注册中心、网关、用户权限管理、代码生成、定时任务、监控等核心功能。 -- 基于 Spring Cloud 、Spring Boot、 OAuth2 的 RBAC **企业快速开发平台**， 同时支持微服务架构和单体架构 -- 提供对 Spring Authorization Server 生产级实践，支持多种安全授权模式 -- 提供对常见容器化方案支持 Kubernetes、Rancher2 、Kubesphere、EDAS、SAE 支持 +## 使用文档 +详细使用文档请参考项目 Wiki 或访问官方文档地址。 -#### 使用文档 - -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) +## 其他产品 +- PigX：Pig 的扩展版本，提供更多企业级功能。 +- Pig4Cloud：Pig 的开源社区版本，持续更新与维护。 ## 微信群 [禁广告] - -1735262426 +欢迎加入 Pig 开发者微信群，交流开发经验与问题。 ## 快速开始 - -#### Docker 快速体验 - -```shell -# 可用内存大于4G -curl -o docker-compose.yaml https://try.pig4cloud.com -# 等待5分钟 -docker compose up +### Docker 快速体验 +确保系统满足以下条件： +- 可用内存大于4G +- 等待5分钟用于初始化服务 + +使用以下命令启动项目： +```bash +docker-compose up -d ``` -### 核心依赖 - -| 依赖 | 版本 | -|-----------------------------|------| -| 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] -``` +## 核心依赖 +- Spring Boot 2.7+ +- Spring Cloud 2021+ +- Spring Cloud Alibaba 2021+ +- Nacos 作为注册中心与配置中心 +- OAuth2 认证授权 +- MyBatis Plus 数据访问层 +- Redis 缓存支持 +- Seata 分布式事务支持 + +## 模块说明 +- **pig-auth**：认证中心，提供 OAuth2 认证与授权。 +- **pig-gateway**：API 网关，负责请求路由与安全控制。 +- **pig-register**：注册中心，基于 Nacos 实现服务注册与发现。 +- **pig-upms**：用户权限管理系统，包含用户、角色、菜单等管理模块。 +- **pig-codegen**：代码生成器，支持数据库表结构自动生成前后端代码。 +- **pig-monitor**：服务监控中心，集成 Spring Boot Admin 进行服务监控。 +- **pig-quartz**：定时任务调度中心，支持任务动态管理与执行。 ## 免费公开课 - - - - - - - - - - -
+定期举办 Pig 微服务开发公开课，欢迎关注官方公众号获取最新信息。 ## 开源共建 +欢迎参与 Pig 项目的开源共建，提交 PR 或 Issue 参与讨论与改进。 -### 开源协议 - -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) - -
- 代码规范说明 - - 1. 由于 spring-javaformat - 强制所有代码按照指定格式排版，未按此要求提交的代码将不能通过合并（打包） - 2. 如果使用 IntelliJ IDEA - 开发，请安装自动格式化软件 - spring-javaformat-intellij-idea-plugin - 3. 其他开发工具，请参考 - spring-javaformat - 说明，或`提交代码前`在项目根目录运行下列命令（需要开发者电脑支持`mvn`命令）进行代码格式化 - ``` - mvn spring-javaformat:apply - ``` -
+## 开源协议 +本项目采用 Apache 2.0 协议，详情请查看 LICENSE 文件。 -2. 欢迎提交 [issue](https://gitee.com/log4j/pig/issues)，请写清楚遇到问题的原因、开发环境、复显步骤。 +## 其他说明 +- 项目文档持续更新中，请关注官方仓库。 +- 如有疑问或需要技术支持，请提交 Issue 或加入微信群交流。 \ No newline at end of file -- Gitee