diff --git a/README.md b/README.md index 17f1fc45..5114ce00 100644 --- a/README.md +++ b/README.md @@ -1,150 +1,66 @@ -

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

+# pig-ui -## 分支说明 +## 概述 -- master: java8 + springboot 2.7 + springcloud 2021 -- jdk17: java17 + springboot 3.2 + springcloud 2023 -- boot(单体版本): java17 + springboot 3.2 +**pig-ui** 是一个为 PIGCLOUD 微服务开发平台开发的前端项目。它利用了现代 Web 技术,包括 Vue.js 3、Element Plus 和 Vite,提供了一个健壮且高效的开发环境。 -## 系统说明 +## 功能特性 -- 基于 Spring Cloud 、Spring Boot、 OAuth2 的 RBAC **权限管理系统** -- 基于数据驱动视图的理念封装 element-plus,即使没有 vue 的使用经验也能快速上手 -- 提供对常见容器化支持 Docker、Kubernetes、Rancher2 支持 -- 提供 lambda 、stream api 、webflux 的生产实践 - -## 文档视频 - -[ 🚀🚀🚀 低代码数据可视化](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) - -## 微信群 [禁广告] - -![](https://minio.pigx.top/oss/1648184189.png) +- **Vue 3**: 利用最新版本的 Vue.js 实现现代化的响应式体验。 +- **Element Plus**: 集成了 Element Plus,提供丰富的 UI 组件。 +- **Vite**: 使用 Vite 进行快速构建和模块热替换。 +- **TypeScript**: 支持 TypeScript,提升代码质量和可维护性。 +- **Tailwind CSS**: 使用 Tailwind CSS 进行样式设计。 ## 快速开始 +### 先决条件 -### 核心依赖 +- **Node.js**: 版本 16.0.0。 +- **npm**: 版本 8.0.0 或更高。 -| 依赖 | 版本 | -|-----------------------------|------------| -| 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 | +### 安装 +1. 克隆仓库: -### 模块说明 - -```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 +```bash 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 +cd pig-ui ``` -## 免费公开课 +2. 安装依赖: - - - - - - - - - -
+```bash +npm install --registry=https://registry.npmmirror.com +``` -## 开源共建 +### 开发 -### 开源协议 +```bash +npm run dev +``` -pig 开源软件遵循 [Apache 2.0 协议](https://www.apache.org/licenses/LICENSE-2.0.html)。 -允许商业使用,但务必保留类作者、Copyright 信息。 +### 构建 -![](https://minio.pigx.top/oss/1655474288.jpg) +为生产环境构建项目: +```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) +## 浏览器支持 -
- 代码规范说明 +- 现代浏览器的最后两个版本。 +- 不支持 IE 11 及更低版本。 - 1. 由于 spring-javaformat - 强制所有代码按照指定格式排版,未按此要求提交的代码将不能通过合并(打包) - 2. 如果使用 IntelliJ IDEA - 开发,请安装自动格式化软件 - spring-javaformat-intellij-idea-plugin - 3. 其他开发工具,请参考 - spring-javaformat - 说明,或`提交代码前`在项目根目录运行下列命令(需要开发者电脑支持`mvn`命令)进行代码格式化 - ``` - mvn spring-javaformat:apply - ``` -
+## 贡献 +欢迎贡献!在开始之前,请阅读[贡献指南](https://www.yuque.com/pig4cloud/pig/lceu0v)。 -2. 欢迎提交 [issue](https://gitee.com/log4j/pig/issues),请写清楚遇到问题的原因、开发环境、复显步骤。 +## 许可证 +本项目采用 Apache-2.0 许可证。 + +## 问题和反馈 +如果遇到任何问题,请在 [PIGCLOUD 问题追踪](https://gitee.com/log4j/pig/issues)上报告。 \ No newline at end of file