slush-laima/templates/README.md

The generator of Laima https://github.com/indigofeather/laima

# Laima

A starter kit of Front-End Tool to develop, showcase, and mock API,
powered by fly and webpack.

Please use <https://github.com/IEMustDie/slush-laima> to generate new projects.

## Commands

```bash
# with mock server
npm satrt

# clear build files
npm run clear

npm run build

# before `release` and `master`, please `build`
# git push `build/release`
npm run release
# git push `build/master`
npm run master

# lint with ESLint
npm run lint

# test with karma-mocha
npm test
```

## Caveats

 - Webpack `reslove.root` = `src/js`
 - `gh-pages` default branch:
    - `release`: `build/release`
    - `master`: `build/master`

## Folder Structure

 - `build/` - build files
 - `src/` - source files
    - `css/`
    - `font/`
    - `img/`
        - `sprites/` - images for sprite
    - `js/`
    - `locales/` - i18n files
    - `static` - static files, copy to `build`
    - `dev.jade`
    - `index.jade`
 - `test/` - testing files
 - api.js mock api
 - mock.js mock server

## Build Folder Structure

 - `build/` - build files
    - `_/`
        - `font/`
        - `img/`
    - `locales/`
    - `application-[hash:7].css`
    - `application-[hash:7].css.map`
    - `bundle-[hash:7].js`
    - `bundle-[hash:7].js.map`
    - `vendor-[hash:7].js`
    - `vendor-[hash:7].js.map`
    - `index.html`
    - `manifest.appcache`

## List of slush-laima-*

 - [slush-laima](https://github.com/IEMustDie/slush-laima)
 - **Deprecated** [slush-laima-ie8](https://github.com/IEMustDie/slush-laima-ie8)

## Tools

 - [font-minify](https://github.com/indigofeather/font-minify)

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)