# generator-kaokei [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Coverage percentage][coveralls-image]][coveralls-url]

> kaokei starter kit

## Installation

First, install [Yeoman](http://yeoman.io) and generator-kaokei using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash
npm install -g yo
npm install -g generator-kaokei
```

Then generate your new project:

```bash
# 创建普通js类库
yo kaokei

# 创建vue的插件类库
yo kaokei:vue
# 创建vue组件
yo kaokei:vue-component
# 创建vue的h5项目，移动端项目，公众号项目，hybrid app项目
yo kaokei:vue-h5
# 创建vue的pc端项目
yo kaokei:vue-web
# 创建vue的chrome浏览器插件
yo kaokei:vue-chrome

# 创建react的插件类库
yo kaokei:react
# 创建react组件
yo kaokei:react-component
# 创建react的h5项目，移动端项目，公众号项目，hybrid app项目
yo kaokei:react-h5
# 创建react的pc端项目
yo kaokei:react-web
# 创建react的chrome浏览器插件
yo kaokei:react-chrome
```

## 补充

对于小程序开发、命令行工具开发、原生 app 开发、flutter 开发、electron 客户端开发。这些暂时不支持。

## Getting To Know Yeoman

- Yeoman has a heart of gold.
- Yeoman is a person with feelings and opinions, but is very easy to work with.
- Yeoman can be too opinionated at times but is easily convinced not to be.
- Feel free to [learn more about Yeoman](http://yeoman.io/).

## License

MIT © [kaokei](kaokei.com)

[npm-image]: https://badge.fury.io/js/generator-kaokei.svg
[npm-url]: https://npmjs.org/package/generator-kaokei
[travis-image]: https://travis-ci.com/kaokei/generator-kaokei.svg?branch=master
[travis-url]: https://travis-ci.com/kaokei/generator-kaokei
[daviddm-image]: https://david-dm.org/kaokei/generator-kaokei.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/kaokei/generator-kaokei
[coveralls-image]: https://coveralls.io/repos/kaokei/generator-kaokei/badge.svg
[coveralls-url]: https://coveralls.io/r/kaokei/generator-kaokei