diff --git a/README.md b/README.md index ef7216524a1c3fb0ecb81bde6c4a63e9296d3a11..9de007b0acfbb3fc5263326fd95bd2b64769c4b7 100644 --- a/README.md +++ b/README.md @@ -1,135 +1,57 @@ -
-
-
-
-
-
-
-
+欢迎加入 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**:定时任务调度中心,支持任务动态管理与执行。
## 免费公开课
-
-![]() |
- ![]() |
-
![]() |
- ![]() |
-