goinstant / colors-common

The Colors Common component is a collection of constants and helper functions for dealing with user colors and is used in various GoInstant widgets.

Colors Common

The Colors Common component is a collection of constants and helper functions for dealing with user colors and is used in various GoInstant widgets.

Contributing

Development Dependencies

• node.js >= 0.8.0
• grunt-cli installed globally
  • npm install -g grunt-cli

Set-Up

The following assumes that you have already installed the dependencies above.

git clone https://github.com/goinstant/colors-common.git
cd colors-common
npm install

Building Colors Common for Development

Colors Common is built as a component. Feel free to manually install dependencies and build using the component command line tool.

For convenience, we've included a simple grunt command for installing component dependencies and building:

grunt build

If this command runs succesfully you'll now have components and build directories in your Git repo root.

Running Tests

Tests are written in mocha. They're run in an HTML file.

Just open the test/index.html file to run the tests.

On Mac OS, you can just run this command to open the HTML Runner in your default browser:

open test/index.html