pig-ui/README.md

66 lines
1.4 KiB
Markdown
Raw Normal View History

2024-06-17 17:04:37 +08:00
# pig-ui
2024-06-17 17:04:37 +08:00
## 概述
2024-06-17 17:04:37 +08:00
**pig-ui** 是一个为 PIGCLOUD 微服务开发平台开发的前端项目。它利用了现代 Web 技术,包括 Vue.js 3、Element Plus 和 Vite提供了一个健壮且高效的开发环境。
2024-06-17 17:04:37 +08:00
## 功能特性
2024-06-17 17:04:37 +08:00
- **Vue 3**: 利用最新版本的 Vue.js 实现现代化的响应式体验。
- **Element Plus**: 集成了 Element Plus提供丰富的 UI 组件。
- **Vite**: 使用 Vite 进行快速构建和模块热替换。
- **TypeScript**: 支持 TypeScript提升代码质量和可维护性。
- **Tailwind CSS**: 使用 Tailwind CSS 进行样式设计。
## 快速开始
2024-06-17 17:04:37 +08:00
### 先决条件
2024-06-17 17:04:37 +08:00
- **Node.js**: 版本 16.0.0。
- **npm**: 版本 8.0.0 或更高。
2024-06-17 17:04:37 +08:00
### 安装
1. 克隆仓库:
2024-06-17 17:04:37 +08:00
```bash
git clone https://gitee.com/log4j/pig-ui.git
2024-06-17 17:04:37 +08:00
cd pig-ui
```
2024-06-17 17:04:37 +08:00
2. 安装依赖:
2024-06-17 17:04:37 +08:00
```bash
npm install --registry=https://registry.npmmirror.com
```
2024-06-17 17:04:37 +08:00
### 开发
2024-06-17 17:04:37 +08:00
```bash
npm run dev
```
2024-06-17 17:04:37 +08:00
### 构建
2024-06-17 17:04:37 +08:00
为生产环境构建项目:
```bash
npm run build
```
2024-06-17 17:04:37 +08:00
为 Docker 构建项目:
```bash
npm run build:docker
```
2024-06-17 17:04:37 +08:00
## 浏览器支持
2024-06-17 17:04:37 +08:00
- 现代浏览器的最后两个版本。
- 不支持 IE 11 及更低版本。
2024-06-17 17:04:37 +08:00
## 贡献
欢迎贡献!在开始之前,请阅读[贡献指南](https://www.yuque.com/pig4cloud/pig/lceu0v)。
2024-06-17 17:04:37 +08:00
## 许可证
本项目采用 Apache-2.0 许可证。
2024-06-17 17:04:37 +08:00
## 问题和反馈
如果遇到任何问题,请在 [PIGCLOUD 问题追踪](https://gitee.com/log4j/pig/issues)上报告。