@barchart/events-public

Public packages for the Barchart Usage Tracking Service — a simple tool for collecting and reporting usage statistics.

Packages

• common-js - Shared JavaScript package, used by the SDK and the backend — published to NPM.
• sdk-js - JavaScript SDK that simplifies interaction with the backend — published to NPM.

Tools

• Yarn and Lerna are used for dependency management.
• Serverless is used for testing and deployment.

Release Process

Use the following procedure to release changes:

• Ensure dependencies are up-to-date.
• Scan the code for lint.
• Create a new file in the .releases folder and commit it.
• Bump the software version across all package.json files and tag the repository.
• Create a GitHub Release based on the tag and add the release notes.
• Finally, publish the packages to NPM.

In other words, execute the following:

yarn run clean
yarn install
yarn run lint
yarn run release

License

This software is provided under the MIT license.