https://github.com/barchart/events-public

Barchart Usage Tracking Service (public packages)
https://github.com/barchart/events-public

events javascript javascript-sdk public-repository sdk usage-tracking

Last synced: 11 days ago
JSON representation

Barchart Usage Tracking Service (public packages)

• Host: GitHub
• URL: https://github.com/barchart/events-public
• Owner: barchart
• License: other
• Created: 2020-09-28T14:31:31.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-17T16:51:28.000Z (6 months ago)
• Last Synced: 2024-05-17T17:26:18.750Z (6 months ago)
• Topics: events, javascript, javascript-sdk, public-repository, sdk, usage-tracking
• Language: JavaScript
• Homepage:
• Size: 1.36 MB
• Stars: 0
• Watchers: 14
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @barchart/events-public

[![AWS CodeBuild](https://codebuild.us-east-1.amazonaws.com/badges?uuid=eyJlbmNyeXB0ZWREYXRhIjoiK2ZWQjNjVVlmMXFQOEJDUjd3SDcxRDI3QUV6NjdFNndoZDRPTjJSa040TDhOMFNpUzdyUXoxVHdha2k0RVlGMW54NjVTVHNhaHNsbzBPdVFhL0h5dFkwPSIsIml2UGFyYW1ldGVyU3BlYyI6IlVGdVpuckREUlRXSVY4LzYiLCJtYXRlcmlhbFNldFNlcmlhbCI6MX0%3D&branch=master)](https://github.com/barchart/events-public)

[![Lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

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

### Packages

* [common-js](./packages/common-js) - Shared JavaScript package, used by the SDK and the backend — published to [NPM](https://www.npmjs.com/package/@barchart/events-api-common).

* [sdk-js](./packages/sdk-js) - JavaScript SDK that simplifies interaction with the backend — published to [NPM](https://www.npmjs.com/package/@barchart/events-client-js).

### Tools

* [Yarn](https://classic.yarnpkg.com/en/) and [Lerna](https://lerna.js.org/) are used for dependency management.

* [Serverless](https://serverless.com/) 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](https://github.com/barchart/events-public/releases) based on the tag and add the release notes.

* Finally, publish the packages to NPM.

In other words, execute the following:

```shell

yarn run clean

yarn install

yarn run lint

yarn run release

```

### License

This software is provided under the MIT license.