# VUE CESIUM

<p align="center">
  <img width="300px" src="https://zouyaoji.top/vue-cesium/favicon.png">
</p>

<p align="center">
  <a href="https://github.com/zouyaoji/vue-cesium/actions/workflows/publish-npm.yml" target="_blank">
    <img src="https://img.shields.io/github/workflow/status/zouyaoji/vue-cesium/Publish%20to%20NPM%20registry?style=plastic">
  </a>
  <a href="https://www.npmjs.com/package/vue-cesium" target="_blank">
    <img src="https://img.shields.io/npm/v/vue-cesium/next?style=plastic">
  </a>
  <a href="https://npmcharts.com/compare/vue-cesium?minimal=true" target="_blank">
    <img src="https://img.shields.io/npm/dm/vue-cesium?style=plastic">
  </a>
  <a href="https://github.com/zouyaoji/vue-cesium/blob/dev/LICENSE" target="_blank">
    <img src="https://img.shields.io/github/license/zouyaoji/vue-cesium?style=plastic">
  </a>
  <a href="https://coveralls.io/github/zouyaoji/vue-cesium?branch=dev" target="_blank">
    <img src="https://img.shields.io/coveralls/github/zouyaoji/vue-cesium?style=plastic">
  </a>
  <br>
</p>

<p align="center">VueCesium - 一套为 GISer 准备的基于 Vue 3.x 的 Cesium 组件库。</p>

- 💪 Vue 3.0 Composition API
- 🔥 Written in TypeScript
- 🎸 IntelliSense for vetur

## 状态: Beta

该项目仍在大力开发中。欢迎加入我们，提出您的第一个 Pull Request。

## 语言

- [中文](https://github.com/zouyaoji/vue-cesium/blob/dev/README.zh.md)
- [English](https://github.com/zouyaoji/vue-cesium/blob/dev/README.md)

- [中文 for vue 2.x](https://github.com/zouyaoji/vue-cesium-v2/blob/master/README.zh.md)
- [English for vue 2.x](https://github.com/zouyaoji/vue-cesium-v2/blob/master/README.md)

## 文档

[https://zouyaoji.top/vue-cesium/#/](https://zouyaoji.top/vue-cesium/#/)

## 开始

命令

```bash
$ yarn bootstrap
```

将安装所有依赖，并且用 `lerna bootstrap` 初始化项目。

## 预览

命令

```bash
$ yarn website-dev
```

将启动站点供您预览已开发的组件和相关文档。

## 创建组件

命令

```bash
$ yarn gen component-name
```

注意组件名称 `component-name` 必须用短横线写法 `kebab-case`。

## 提交模板

命令

```bash
yarn cz
```

例如

```
[TYPE](SCOPE):DESCRIPTION#[ISSUE]
# example feat(viewer):add type 'viewer' for form usage #1234
```
