light-bringer / monster-ui

Monster UI core: The JS framework of the new UI for KAZOO

Monster UI

• Getting Started
  • Prerequisites
  • Install
  • Configure
  • Build
• Using Docker
• Contributing
• Authors
• License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development purposes. See the Using Docker section for notes on how to automate the following steps by running a script within a Docker container

Prerequisites

• node >= 4.5.0
• npm >= 3.10.6
• gulp >= 3.9.1

Install

Clone my fork of Official monster-ui repository:

git clone https://github.com/light-bringer/monster-ui.git monster-ui

Go to the project's folder:

cd monster-ui

Install dependencies:

npm install

Configure

In order for the UI to load the data from your server, we need to specify which API to use. To do so, open the config.js file located in src/js/ folder and add the URL of your server as the value of the default property.

define(function(require) {

  return {
    api: {
      // The default API URL defines what API is used to log in to your back-end
      default: 'http://my.server.url/' // could be formatted like http://api.server.net:8000/v2/

      ...
    },

    ...
  };
});

Build

Use the gulp command to build and launch the web server

gulp

Access your development environment at http://localhost:3000/

For more info on how the gulp command works, head to the dedicated documentation

Using Docker

If you are using Docker containers, we made it easy for you to set up a development environment. You will just need to clone the monster-ui repository and add your API URL to the config.js file as explained in the Install and Configure sections. After that, execute our custom serve.sh script (made by Pierre Fenoll) in your Docker container:

./serve.sh

This script will install npm and gulp, as well as the npm dependencies and finally run the gulp command. You will be able to access the development environment at http://localhost:3000/.

It also starts by pulling your apps installed in src/apps before starting the server. To disable this behavior use the no-update flag:

./serve.sh no-update

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

Authors

2600Hz employees actively working on this project:

• Jean-Roch Maitre
• Joris Tirado

See also the list of contributors who participate in this project.

License

This project is licensed under the Mozilla Public License - see the LICENSE file for details.