cellcube-ussd-app-generator-nodejs/README.md

myranogen' An npm Module to generate USSD apps for Cellcube platform

[![Express Logo](http://telestax.wpengine.netdna-cdn.com/wp-content/uploads/2014/03/USSD-Gateway-logo.png)](http://www.orange.ci/)

[cellgen'](https://www.npmjs.com/package/cellcube-ussd-app-generator-nodejs) USSD app generator.

## Installation

```sh
$ npm install -g cellcube-ussd-app-generator-nodejs
```

## Quick Start

The quickest way to get started with building USSD apps for CellCube platform as shown below:

Create the app:

```bash
$ cellgen /tmp/foo && cd /tmp/foo
```

Install dependencies:

```bash
$ npm install
```

Rock and Roll

```bash
$ npm start
```

## Command Line Options

This generator can also be further configured with the following command line flags.

    -h, --help                output usage information
    -V, --version             output the version number
        --git                 add .gitignore
    -e  --noenvironment       do not configure server app for testing
    -a  --samples             add samples code to generated files
    -l  --languages           add multi language support files
    -f, --force               force on non-empty directory
    -d, --description [desc]  defines USSD app description [description]
    Options:

## Start with a sample app
Use the following commands to set up and launch a sample app

```bash
$ cellgen /tmp/foo && cd /tmp/foo && npm install
$ node ./bin/www
```
Now, open your favourite browser (or web client) and navigate to
[http://localhost:4000/](http://localhost:4000/)
You can change the app port, by editing /bin/www file.

## License

[MIT](LICENSE)