# WebuxJS

This is the framework for Studio Webux Projects

Please visit : https://webuxlab.com for official documentation.

# Installation

To launch tests and/or use Grunt

```bash
npm install -g grunt-cli
npm install -g jest
```

## Usage

this module covers a lot of stuffs,

firstly,
the index.js file is the entry point.
it loads the app/index.js file, that one contains the whole application. Meaning, it will call the modules required by the application, you can update that file like you want.

secondly,
the api/
it contains the application logics

thirdly,
the rest of the directories are there to support the application.

I will write a more detailled documentation that cover the modules plus the framework.

### How to customize everything for your needs

you can fork the @studiowebux/app project on github [@studiowebux/app](https://github.com/studiowebux/webux-app), and add/update and remove stuffs.

If you add something, you can also share it with everyone, by creating a pull request.

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

SEE LICENSE IN license.txt