mirror of
https://gitee.com/log4j/pig-ui.git
synced 2024-12-23 05:40:20 +08:00
:doc: 增加README说明文档
This commit is contained in:
冷冷
GitHub
parent
14be7082e6
commit
48bef06524
170
README.md
170
README.md
@ -1,150 +1,66 @@
|
|||||||
<p align="center">
|
# pig-ui
|
||||||
<img src="https://img.shields.io/badge/Pig-3.7-success.svg" alt="Build Status">
|
|
||||||
<img src="https://img.shields.io/badge/Spring%20Cloud-2023-blue.svg" alt="Coverage Status">
|
|
||||||
<img src="https://img.shields.io/badge/Spring%20Boot-3.2-blue.svg" alt="Downloads">
|
|
||||||
<img src="https://img.shields.io/badge/Vue-3.4-blue.svg" alt="Downloads">
|
|
||||||
<img src="https://img.shields.io/github/license/pig-mesh/pig"/>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## 分支说明
|
## 概述
|
||||||
|
|
||||||
- master: java8 + springboot 2.7 + springcloud 2021
|
**pig-ui** 是一个为 PIGCLOUD 微服务开发平台开发的前端项目。它利用了现代 Web 技术，包括 Vue.js 3、Element Plus 和 Vite，提供了一个健壮且高效的开发环境。
|
||||||
- jdk17: java17 + springboot 3.2 + springcloud 2023
|
|
||||||
- boot(单体版本): java17 + springboot 3.2
|
|
||||||
|
|
||||||
## 系统说明
|
## 功能特性
|
||||||
|
|
||||||
- 基于 Spring Cloud 、Spring Boot、 OAuth2 的 RBAC **权限管理系统**
|
- **Vue 3**: 利用最新版本的 Vue.js 实现现代化的响应式体验。
|
||||||
- 基于数据驱动视图的理念封装 element-plus，即使没有 vue 的使用经验也能快速上手
|
- **Element Plus**: 集成了 Element Plus，提供丰富的 UI 组件。
|
||||||
- 提供对常见容器化支持 Docker、Kubernetes、Rancher2 支持
|
- **Vite**: 使用 Vite 进行快速构建和模块热替换。
|
||||||
- 提供 lambda 、stream api 、webflux 的生产实践
|
- **TypeScript**: 支持 TypeScript，提升代码质量和可维护性。
|
||||||
|
- **Tailwind CSS**: 使用 Tailwind CSS 进行样式设计。
|
||||||
## 文档视频
|
|
||||||
|
|
||||||
[ 🚀🚀🚀 低代码数据可视化](http://datav.pig4cloud.com)
|
|
||||||
|
|
||||||
[ 配套文档 wiki.pig4cloud.com](https://wiki.pig4cloud.com)
|
|
||||||
|
|
||||||
[ 配套视频 tv.pig4cloud.com](https://www.bilibili.com/video/BV12t411B7e9)
|
|
||||||
|
|
||||||
[PIGX 在线体验 pigx.pigx.top](http://pigx.pigx.top)
|
|
||||||
|
|
||||||
[产品白皮书 paper.pig4cloud.com](https://paper.pig4cloud.com)
|
|
||||||
|
|
||||||
## 微信群 [禁广告]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 快速开始
|
## 快速开始
|
||||||
|
|
||||||
|
### 先决条件
|
||||||
|
|
||||||
### 核心依赖
|
- **Node.js**: 版本 16.0.0。
|
||||||
|
- **npm**: 版本 8.0.0 或更高。
|
||||||
|
|
||||||
| 依赖 | 版本 |
|
### 安装
|
||||||
|-----------------------------|------------|
|
1. 克隆仓库：
|
||||||
| Spring Boot | 3.2.4 |
|
|
||||||
| Spring Cloud | 2023.0.1 |
|
|
||||||
| Spring Cloud Alibaba | 2022.0.0.0 |
|
|
||||||
| Spring Authorization Server | 1.2.3 |
|
|
||||||
| Mybatis Plus | 3.5.5 |
|
|
||||||
| Vue | 3.4 |
|
|
||||||
| Element Plus | 2.5 |
|
|
||||||
|
|
||||||
### 模块说明
|
```bash
|
||||||
|
|
||||||
```lua
|
|
||||||
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-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](https://www.yuque.com/pig4cloud/pig/vsdox9)，包括开发环境安装、服务端代码运行、前端代码运行等。
|
|
||||||
|
|
||||||
请务必**完全按照**文档部署运行章节 进行操作，减少踩坑弯路！！
|
|
||||||
|
|
||||||
|
|
||||||
### 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
|
git clone https://gitee.com/log4j/pig-ui.git
|
||||||
|
cd pig-ui
|
||||||
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
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## 免费公开课
|
2. 安装依赖：
|
||||||
|
|
||||||
<table>
|
```bash
|
||||||
<tr>
|
npm install --registry=https://registry.npmmirror.com
|
||||||
<td><a href="https://www.bilibili.com/video/av45084065" target="_blank"><img src="https://minio.pigx.top/oss/1655474345.jpg"></a></td>
|
```
|
||||||
<td><a href="https://www.bilibili.com/video/av77344954" target="_blank"><img src="https://minio.pigx.top/oss/1656837143.jpg"></a></td>
|
|
||||||
</tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="https://www.bilibili.com/video/BV1J5411476V" target="_blank"><img src="https://minio.pigx.top/oss/1655474369.jpg"></a></td>
|
|
||||||
<td><a href="https://www.bilibili.com/video/BV14p4y197K5" target="_blank"><img src="https://minio.pigx.top/oss/1655474381.jpg"></a></td>
|
|
||||||
</tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## 开源共建
|
### 开发
|
||||||
|
|
||||||
### 开源协议
|
```bash
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
pig 开源软件遵循 [Apache 2.0 协议](https://www.apache.org/licenses/LICENSE-2.0.html)。
|
### 构建
|
||||||
允许商业使用，但务必保留类作者、Copyright 信息。
|
|
||||||
|
|
||||||
|
为生产环境构建项目：
|
||||||
|
```bash
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
### 其他说明
|
为 Docker 构建项目：
|
||||||
|
```bash
|
||||||
|
npm run build:docker
|
||||||
|
```
|
||||||
|
|
||||||
1. 欢迎提交 [PR](https://dwz.cn/2KURd5Vf)，注意对应提交对应 `dev` 分支
|
## 浏览器支持
|
||||||
代码规范 [spring-javaformat](https://github.com/spring-io/spring-javaformat)
|
|
||||||
|
|
||||||
<details>
|
- 现代浏览器的最后两个版本。
|
||||||
<summary>代码规范说明</summary>
|
- 不支持 IE 11 及更低版本。
|
||||||
|
|
||||||
1. 由于 <a href="https://github.com/spring-io/spring-javaformat" target="_blank">spring-javaformat</a>
|
## 贡献
|
||||||
强制所有代码按照指定格式排版，未按此要求提交的代码将不能通过合并（打包）
|
欢迎贡献！在开始之前，请阅读[贡献指南](https://www.yuque.com/pig4cloud/pig/lceu0v)。
|
||||||
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)，请写清楚遇到问题的原因、开发环境、复显步骤。
|
## 许可证
|
||||||
|
本项目采用 Apache-2.0 许可证。
|
||||||
|
|
||||||
|
## 问题和反馈
|
||||||
|
如果遇到任何问题，请在 [PIGCLOUD 问题追踪](https://gitee.com/log4j/pig/issues)上报告。
|
||||||
Loading…
Reference in New Issue
Block a user