web/demos/README.md

Web Demos
===============

Web Application for DataTorrent Demos:
- Twitter URLs
- Twitter Hashtags
- Mobile
- Machine Generated Data
- Ads Dimensions
- Fraud

## Architecture

![Demos Architecture](docs/demos_architecture.png "Demos Architecture")

## Running Demos
 Demos run on [Node.js](http://nodejs.org/).
 See [package](package) to run demos with prefetched runtime dependencies (only Node.js is required).

## Running Demos in Development Mode
 Install npm dependencies:

 ``` bash
    $ npm install
 ```

 Install Bower dependencies:

 ``` bash
    $ bower install
 ```

 Start Node.js server:

 ``` bash
    $ node app.js
 ```

 Application will be available at http://localhost:3003

## Demos configuration
 Please use ```config.js``` or environment variables for configuration (DT Gateway, Redis, MongoDB, etc.).
 See ```dist_start.sh``` and ```dev_start.sh```.

 Applications are automatically discovered by name (to show stats like "Events/sec"). See the following settings in ```config.js```:
 - settings.twitterUrls.appName
 - settings.twitterHashtags.appName
 - settings.mobile.appName
 - settings.machine.appName
 - settings.dimensions.appName
 - settings.fraud.appName

## Tips

 Running Node.js as a daemon with [forever](https://github.com/nodejitsu/forever)

 ``` bash
    $ npm install forever -g
    $ forever start app.js
    $ forever list
    $ forever stop <uid>
 ```

 Running Node.js on different port

 ``` bash
    $ PORT=3001 node app.js
 ```

## Links

[Express](https://github.com/visionmedia/express) Node.js web framework

[node_redis](https://github.com/mranney/node_redis) Node.js Redis client

[forever](https://github.com/nodejitsu/forever) Node.js daemon/continuous running/fault tolerance