https://github.com/dreamqyq/coast-ui-vue3

Coast UI for Vue3
https://github.com/dreamqyq/coast-ui-vue3

coast-ui typescript vite vitejs vue vue3

Last synced: 3 months ago
JSON representation

Coast UI for Vue3

• Host: GitHub
• URL: https://github.com/dreamqyq/coast-ui-vue3
• Owner: dreamqyq
• License: mit
• Created: 2020-10-27T08:55:13.000Z (about 4 years ago)
• Default Branch: dev
• Last Pushed: 2022-07-10T13:41:22.000Z (over 2 years ago)
• Last Synced: 2024-10-01T16:20:00.133Z (3 months ago)
• Topics: coast-ui, typescript, vite, vitejs, vue, vue3
• Language: Vue
• Homepage: https://dreamqyq.github.io/coast-ui-vue3/
• Size: 1.54 MB
• Stars: 13
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Coast UI for Vue3

![GitHub Workflow Status](https://img.shields.io/github/workflow/status/dreamqyq/coast-ui-vue3/Unit%20Test) [![Codecov](https://img.shields.io/codecov/c/github/dreamqyq/coast-ui-vue3)](https://app.codecov.io/gh/dreamqyq/coast-ui-vue3) [![https://www.npmjs.com/package/coast-ui-vue3](https://img.shields.io/npm/l/coast-ui-vue3)](https://www.npmjs.org/package/coast-ui-vue3) [![NPM Version](http://img.shields.io/npm/v/coast-ui-vue3.svg?style=flat)](https://www.npmjs.org/package/coast-ui-vue3) [![NPM Downloads](https://img.shields.io/npm/dm/coast-ui-vue3.svg?style=flat)](https://npmcharts.com/compare/coast-ui-vue3?minimal=true) ![vue version](https://img.shields.io/github/package-json/dependency-version/dreamqyq/coast-ui-vue3/dev/vue) ![vite version](https://img.shields.io/github/package-json/dependency-version/dreamqyq/coast-ui-vue3/dev/vite)

## 介绍

基于 `Vue3` 及 `TypeScript` 的组件库，代码易读，每个组件的源代码都极其简洁。本项目基于 `Vite2.x` 构建。

## 如何使用

### 安装

```

yarn add coast-ui-vue3

```

或

```

npm install coast-ui-vue3

```

### 引入 coast-ui-vue3

```

import { CoButton, CoTabs, CoSwitch, CoDialog, openDialog } from "coast-ui-vue3"

import "coast-ui-vue3/package/coast-ui.css";

```

### 本项目使用

- 官网本地运行

  - `yarn` 安装依赖

  - `yarn dev` 运行

- 组件打包，基于 rollup

  - `yarn build:lib`

- 组件单元测试，基于 jest

  - `yarn test:lib`

- 自动生成 changelog，基于 conventional-changelog

  - `yarn changelog`

### 自动化

本项目基于 Github Actions，实现了一系列自动化脚本：

- 自动化测试

  - `unit-test`

  - 改动了 lib 目录下的文件 或者 package.json ，并 push 到 dev 分支上，自动执行组件库的单元测试。

- 自动化构建官网（依赖 gh-pages）

  - `master-deploy`

  - 新代码 push 到 master 分支上，自动构建官网并发布到 gh-pages。

- 自动化发布 npm 包

  - `publish-npm`

  - 创建新的 release，自动测试并把最新的包发布到 npm。

## 文档

要查看实时示例和详细的组件文档，请访问[文档](https://dreamqyq.github.io/coast-ui-vue3/#/)。

## 变更记录

[CHANGELOG](https://github.com/dreamqyq/coast-ui-vue3/blob/master/CHANGELOG.md) 中记录了每个发行版的详细更改。

## License

[MIT](https://opensource.org/licenses/MIT)

Copyright (c) 2021 Enoch Qin