# nova-ui

**Repository Path**: nova-group/nova-ui

## Basic Information

- **Project Name**: nova-ui
- **Description**: 基于ElementPlus的业务组件库
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2023-07-10
- **Last Updated**: 2025-12-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Nova-UI

[![lerna](https://img.shields.io/badge/maintained%20with-pnpm-cc00ff.svg)](https://www.pnpm.cn/) 基于[Element-Plus](https://element-plus.gitee.io/zh-CN/)的业务组件库

```bash
.
├── docs            # 文档
├── packages
│   ├── components  # 业务组件
│   └── nova-ui     # 组件库(对外发包)
└── play            # 开发演示
```

### 开发环境搭建

首先你需要 Node 版本要等于或者高于 16.14.2。【注意】：我们使用的是 Monorepo 架构，文档、组件库、演示都在一个仓库中，使用的是 pnpm 来进行依赖管理，所以请使用 `npm install -g pnpm` 安装 pnpm。

```shell
# 克隆仓库
git clone https://gitee.com/nova-group/nova-ui.git

# 切换到dev分支
git checkout dev

# 创建新分支feature/xxx ，并切换到新分支上
git checkout -b feature/xxx dev

# 安装依赖
pnpm i

# 开发
pnpm dev

# open http://localhost:8080
```

### 组件开发规范

- [开发规范](http://124.223.17.222/web/rule/components/home.html)

### Merge Request 规范

- 创建分支： `分支类型/组件名/issue-id`，例如：`feature/search/issue-2` （组件名不用前缀名，kebab-case），这样我们知道是在 Search 组件基于 2 issue 添加了新特性。如果没有 issue，可创建大致描述功能的名称，例如：`feature/searchConfig` search 组件的搜索配置功能；

  - **分支类型**有：
    - `feature` 新特性
    - `hotfix` Bug 修复
    - `docs` 文档调整修改

- commit 不可通过 git commit 或者 开发工具的代码提交功能提交代码，严格使用 `package.json` 命令提交：`pnpm commit`。

- 自测后，执行 `pnpm build` 后检查是否可以正确打包组件。

- 确保 MR 是提交到 `dev` 分支，而不是 `master` 分支。

- 合并代码分配到 @zhaoguangyao。

## 初始化

```bash
# 根路径下
pnpm i
```

## 文档开发

```bash
# 根路径下
pnpm run docs:dev
```

### 组件开发

```bash
# 根路径下
pnpm run dev
```

### 自动创建组件

```bash
# 根路径下
# 创建button组件
pnpm cre button

# 创建 button 、 icon 、 list 组件
pnpm cre button icon list
```

### 文档构建

```bash
# 根路径下
pnpm run docs:build
```

### 组件构建

```bash
# 根路径下
pnpm run build
```

### 发布版本

```bash
# 根路径下
pnpm run release

cd packages nova-ui

npm publish
```