Pip.WebUI.Behaviors Developer's Guide

Installing

1. - Download and install Node.js from https://nodejs.org/en/download/

2. - Install required build and test tools.

npm install gulp-cli -g
npm install mocha -g

3. Clone the project from github repository.

git clone https://github.com/pip-webui/pip-webui-behaviors.git

4. Install project dependencies.

Install all dependencies for the first time:

npm install

Or update dependencies after they were installed:

npm update

Clean /build and /dist directories. It is an optional step to ensure you removed any garbage.

gulp clean

Build source code. It will automatically check for errors and regenerate API documentation. If any error found the build will fail.

gulp build

Uploading samples and API documentation to S3 static websites:

gulp publish

1. Check and update CHANGELOG.md file.

2. Change version number in package.json. Remember: use semantic version and push changes to git repository.

3. Set tag corresponding to the module version.

git tag vx.y.z
git push origin master --tags

4. Publish release to the global NPM repository.

Remember: to publish to NPM you must have proper permissions from the team.

npm login
npm publish

For those who would like to contribute to the project as external contributor or become a part of Pip.WebUI team, please, read Contributor's Guide.