cliengo-sdk

# cliengo-sdk

We offer a powerful Javascript API that gives you flexibility and config, control and track over the behavior of the Cliengo Platform. You can decide, how, when and where to display the chat box on your site, as well as view and update visitor information. You can also track informations and events in web platforms out of the box, including Google Analytics, Google Adwords, Facebook Ads and Google Tag Manager.

Setup and build instrucctions

Cliengo SDK was built using https://www.npmjs.com/package/generator-javascript-library

For every change in source code:

git add . git cz # commit using commitizen. Choose the 'feat' commit type for the creation of your library! git push origin master

Publish new versions

npm version minor npm publish

Understand the dev process of your new library

Testing

• Run the tests: npm run test or npm tests or npm t
• Run the tests and compute coverage : npm run test:with-coverage. Html coverage reports will be in the "coverage/lcov-report/" folder.
• Check that coverage is 100 percent: npm run test:check-coverage

Building

• Build your library for npm: npm run build:lib
• Build your library for the browser: npm run build:umd or minified with npm run build:umd.min
• All of the above: npm run build
• If you chose to not have a browser build, there's just npm run build which does the same as npm run build:lib.

Other useful scripts

• Clean coverage reports: npm run clean:coverage
• Clean build artifacts: npm run clean:build
• All of the above: npm run clean

Commiting

You can commit like you normally would, but you'll have to follow the angular conventional commit format. To help you do this you can use commitizen (see usage section).

Before each commit is taken into account, the tests wil be run and the coverage will be checked. If this fails, you can commit with the same message by running git cz --retry.

The commit message is also validated to ensure you respect the format. This is important so that the semantic-release module works properly.