generator-xweb/app/templates/_readme.md

Scaffold out a front-end rest web app, user bower and npm at same time

XWEB
========================
it is a pure browser side project, decoupled with backend. Cool and fancy.

Use restful api to connect backend services.

Use bower, npm and static vendor file as our dependencies repos.


Background
-------------
1. [bootstrap3](http://getbootstrap.com/)
1. [TODO APP](http://flatfull.com/themes/todo/blog.html) it is not free for commercial perpouse.
1. [Browserify](http://browserify.org)
1. [backbone.marionette](https://github.com/marionettejs/backbone.marionette) main framework
1. [backbone.routeFilter](https://github.com/boazsender/backbone.routefilter)
1. [handlebars](http://handlebarsjs.com/) template engine
1. [mocha](https://github.com/visionmedia/mocha/) test frame work


Prepare for *Delveloper*
-------------
1.  a text editor for hbs、js、html、nodejs and etc.
1.  nodejs(>=0.10.13)
1.  npm install -g gulp bower mocha


Dependencies
---------

To install dependencies from npm and bower, run:

```bash
npm install & bower install
```

Quick Start
------------

    // start with fake server
    gulp

    // start with online server
    // make sure you edit the config file which contains server config
    gulp --online



Configuration
--------

You can change your configurations under the config directory, please notify default.json is in the git repository.
read more about [node-config](https://github.com/lorenwest/node-config).

When gulp is started, it will open a browser automatically, it is supported by browserSync.
If you want to change it to another browser, please edit "browser" in default.json. Like ``` "browser": "chrome" ```



Contact
-------
zzswang@gmail.com