generator-zeus/README.md

组件脚手架

# 组件开发目录脚手架

> 通过脚手架可以生成基于React或基于jQuery的项目基本目录，加快开发速度！

## 安装

    npm install -g yo generator-zeus   //全局安装yo和generator-zeus
    
## 使用

### 创建基本目录及文件

    mkdir myProject
    cd myProject
    yo zeus
    
选择您要创建的插件类型后即可自动创建所需的项目目录及文件。

### 安装依赖

请在安装依赖前删除不必要的依赖

    npm install
   
### 开发

    npm run dev

运行命令后请打开浏览器地址<code>http://localhost:8080</code>。

**注意：**

- 如果报错，有可能是fis3服务器占用端口了，请运行<code>fis3 server stop</code>停用fis3服务器；
- 如果想用端口而不是localhost，请在```webpack.config.js```里找到```new OpenBrowserPlugin({ url: 'http://localhost:8080' })```并修改host，然后重启；

### 编译打包

    npm run build
  
**注意：**

- 将会生成压缩版和未压缩版本，记得压缩完后修改package.json的版本号以及修改```main```字段。
- 发布前请记得修改以下字段：
    - ```package.json```: 版本号(```version```)
    - ```component.json```: 版本号(```version```)、描述(```description```)、仓库gitLab地址(```repos```)、svn地址(```svn```)、作者信息(```author```)
    
### 发包

如果有重大功能改变，请记得在群里发包，格式详见群里公告栏。

## 生成的目录结构

- React组件目录
    - dist/
    - src/
    - example/
        - index.html
        - index.js
    - docs/
    - README.md
    - webpack.config.js
    - webpack.prod.config.js
    - package.json
    - .gitignore
- jQuery插件目录(TODO)


### 更新日子

- v1.0.9: 增加对```.jsx```后缀文件的监听；还是去掉自动打开浏览器吧；
- v1.0.7: 增加component.json文件；打包时增加非压缩版本和压缩版本两个文件；开发时运行```npm run dev```时自动打开浏览器；