@meetrix/webrtc-monitoring-common-lib

This repository maintains shared utils and types across multiple projects

Project can be run on following OS

1. Ubuntu
2. MacOS
3. Windows

Prerequisites

The following pre-requisites should be setup through your terminal on your development machine. Please refer to tool installation guides by the developers to set these up.

1. Git
2. Node 16

Usage

1. insert webrtc-monitoring-common-lib to dependencies array

   "@meetrix/webrtc-monitoring-common-lib": "git+https://github.com/meetrix/webrtc-monitoring-common-lib.git",

2. Import it into your source code

   import { Report } from '@meetrix/webrtc-monitoring-common-lib';

Development

1. Clone the repository
2. Create a new branch for the task e.g.: chore/WMS-999--fix-ci
3. Do the changes
4. Make sure the code is up to the standards/conventions and commit+push the changes

Deployment

1. Decide on a version number https://semver.org/
2. Update package.json and package-lock.json "version" field
3. Add/merge this to master/main branch