generator-codexmedia

<%= projectname %>-<%= name %>

[](https://www.npmjs.com/package/<%= projectname %>-<%= name %>) [](https://gitter.im/<%= projectname %>/discuss?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://circleci.com/gh/<%= projectname %>js/<%= name %>)

This library is part of the <%= projectname %> platform and contains a <%= description %>.

To keep up to date on <%= projectname %>, please visit and subscribe to [the official blog](http://blog.<%= projectname %>js.com/) and [our email list](http://eepurl.com/<%= projectname %>js). We also invite you to follow us on twitter. If you have questions look around our Discourse forums, chat in our [community on Gitter](https://gitter.im/<%= projectname %>js/discuss) or use [stack overflow](http://stackoverflow.com/search?q=<%= projectname %>js). Documentation can be found [in our developer hub](<%= projectwebpage %>docs). If you would like to have deeper insight into our development process, please install the ZenHub Chrome or Firefox Extension and visit any of our repository's boards.

Documentation

You can read documentation on the <%= projectname %>js-<%= name %> [here](<%= projectwebpage %>docs/<%= projectname %>js-<%= name %>). If you would like to help improve this documentation, the source for the above can be found in the doc folder within this repository.

Platform Support

This library can be used in the browser or on the server. A Fetch API polyfill may be needed.

Building The Code

To build the code, follow these steps.

• Ensure that NodeJS is installed. This provides the platform on which the build tooling runs.
• From the project folder, execute the following command:

npm install

• Ensure that Gulp is installed. If you need to install it, use the following command:

npm install -g gulp

• To build the code, you can now run:

gulp build

• You will find the compiled code in the dist folder, available in three module formats: AMD, CommonJS and ES6.

• See gulpfile.js for other tasks related to generating the docs and linting.

Running The Tests

To run the unit tests, first ensure that you have followed the steps above in order to install all dependencies and successfully build the library. Once you have done that, proceed with these additional steps:

• Ensure that the Karma CLI is installed. If you need to install it, use the following command:

npm install -g karma-cli

• Ensure that jspm is installed. If you need to install it, use the following commnand:

npm install -g jspm

• Install the client-side dependencies with jspm:

jspm install

• You can now run the tests with this command:

karma start