pig/README.md at 6acd14c6989acfcfbcb25b88b6f5e0252520fde2

mirror of https://gitee.com/log4j/pig.git synced 2024-12-22 12:48:58 +08:00

Signed-off-by: Mac666 <support@mail.pigx.vip>

2023-08-24 13:46:36 +00:00

5.7 KiB

Raw Blame History

分支说明

master: java8 + springboot 2.7 + springcloud 2021
jdk17: java17 + springboot 3.1 + springcloud 2022

系统说明

基于 Spring Cloud 、Spring Boot、 OAuth2 的 RBAC 权限管理系统
基于数据驱动视图的理念封装 element-plus，即使没有 vue 的使用经验也能快速上手
提供对常见容器化支持 Docker、Kubernetes、Rancher2 支持
提供 lambda 、stream api 、webflux 的生产实践

文档视频

🚀🚀🚀 低代码数据可视化

配套文档 wiki.pig4cloud.com

配套视频 tv.pig4cloud.com

PIGX 在线体验 pigx.pigx.top

产品白皮书 paper.pig4cloud.com

微信群 [禁广告]

快速开始

核心依赖

依赖	版本
Spring Boot	3.1.3
Spring Cloud	2022.0.4
Spring Cloud Alibaba	2022.0.0.0
Spring Authorization Server	1.1.2
Mybatis Plus	3.5.3.2
hutool	5.8.21

模块说明

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

pig
├── pig-auth -- 授权服务提供[3000]
└── pig-common -- 系统公共模块
     ├── pig-common-bom -- 全局依赖管理控制
     ├── pig-common-core -- 公共工具类核心包
     ├── pig-common-datasource -- 动态数据源包
     ├── pig-common-job -- xxl-job 封装
     ├── 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]

本地开发运行

pig 提供了详细的部署文档 wiki.pig4cloud.com，包括开发环境安装、服务端代码运行、前端代码运行等。

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

Docker 运行

# 下载并运行服务端代码
git clone https://gitee.com/log4j/pig.git -b jdk17

cd pig && mvn clean install && docker-compose up -d

# 下载并运行前端UI
git clone https://gitee.com/log4j/pig-ui.git

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


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

免费公开课

开源共建

开源协议

pig 开源软件遵循 Apache 2.0 协议。允许商业使用，但务必保留类作者、Copyright 信息。

其他说明

欢迎提交 PR，注意对应提交对应 dev 分支代码规范 spring-javaformat
代码规范说明
1. 由于 spring-javaformat 强制所有代码按照指定格式排版，未按此要求提交的代码将不能通过合并（打包）
2. 如果使用 IntelliJ IDEA 开发，请安装自动格式化软件 spring-javaformat-intellij-idea-plugin
3. 其他开发工具，请参考 spring-javaformat 说明，或提交代码前在项目根目录运行下列命令（需要开发者电脑支持mvn命令）进行代码格式化
```
mvn spring-javaformat:apply
```
欢迎提交 issue，请写清楚遇到问题的原因、开发环境、复显步骤。

5.7 KiB Raw Blame History Unescape Escape