## readme

#### install 
* install global `npm install files-explore -g`
* start `files-explore path portr`
 * for example 'files-explore /usr/local 8080'
 * `path` is the directory you want to show, the default value is current path
 * `port` is the http server port, default value is `8088`

#### 安装
* 全局安装 ``npm install files-explore -g`
* 启动 `files-explore path port `
 *  比如 `files-explore /usr/local 8080`
 * `path` 参数是你想访问的文件夹路径，默认值是当前路径
 * `port` 参数是http服务器的端口号，默认值是`8088`

##### instruction
* it support image `thumbnail`, but you must install `imagemagick`. If you are a Mac user, you can install `imagemagick` with [brew](http://brew.sh/). `brew install imagemagick `.

* it also support `video thumbnail` and other types of vide, but you must install `ffmpeg`. If you are a Mac user, you can install with brew, `brew install ffmpeg`.

#### 说明
* 如果想显示缩略图，请先安装`imagemagick`，Mac系统可以使用`brew install imagemagick`
* 如果想显示视频缩略图和在线预览`mp4` `mkv`之外的格式视频， 请安装`ffmpeg`，Mac系统可以使用`brew install ffmpeg`

#### develop
* it build with [browserify-build](https://www.npmjs.com/package/browserify-build), it is a build tool with [browserify](http://browserify.org) [browser-sync](http://www.browsersync.io) [gulp](http://gulpjs.com/)
* `git clone https://github.com/chenkehxx/files-explore.git `
* `npm install`
*  `npm install -g browserify-build`
* `node server/app path port`
* `browserify-build config`
* `browserify-build start`
* open the url: `http://localhost:8080` with brower

#### 开发
* 开发构建工具是[browserify-build](https://www.npmjs.com/package/browserify-build),这是一个基于[browserify](http://browserify.org) [browser-sync](http://www.browsersync.io) [gulp](http://gulpjs.com/)的构建工具
* `git clone https://github.com/chenkehxx/files-explore.git`
* `npm install`
* `npm install -g browserify-build`
* `node server/app path port`
* `browserify-build config`
* `browserify-build start`
* 在浏览器中打开``http://localhost:8080

#### tips
 * it supports `es6`,
 * it supports `unit test`, the config file is at `test/karma.conf.js`, then you can run the test with the command line `karma start test/karma.conf.js`
 * it supports `e2e test`, the config file is at `test/protractor.conf.js `, then you can run the test with the comman line `protractor test/protractor.conf.js `
 
#### 提示
 * 支持es6写法
 * 支持`unit test` 相关配置文件在`test/karam.conf.js` 执行命令`karma start test/karma.conf.js`
 * 支持`e2e test` 相关配置文件在`test/protractor.conf.js` 执行命令`protractor test/protractor.conf.js`


#### screenshots
![screenshots](https://img.alicdn.com/imgextra/i2/683489026/TB2i9w1fFXXXXX2XXXXXXXXXXXX_!!683489026.png)
![screenshots](https://img.alicdn.com/imgextra/i3/683489026/TB2ePZDfFXXXXaQXpXXXXXXXXXX_!!683489026.png)


