Skip to content

Latest commit

 

History

History
108 lines (67 loc) · 3.05 KB

README.md

File metadata and controls

108 lines (67 loc) · 3.05 KB
Raw

Plivo-Browser SDK-v2

Introduction

The Plivo Browser SDK codebase wraps the functions of Browser SDK as an ES module. To get started, see the SDK overview and SDK reference docs. For release notes, see the Changelog.

Installation

NPM

You can include the Plivo-Browser-SDK NPM package as a dependency in your project. To do this, use the command

npm install plivo-browser-sdk --save

Usage

You can import Browser SDK using ES module or TypeScript syntax

import Plivo from 'plivo-browser-sdk'

or using commonJS

const Plivo = require('plivo-browser-sdk');

CDN

You can also include the Plivo JavaScript file shown below directly on your webpage if you don't want to include the package as a dependency.

<script type="text/javascript" src="https://cdn.plivo.com/sdk/browser/v2/plivo.min.js"></script>

TypeScript Support

This Browser SDK package includes TypeScript declarations for Plivo Browser SDK. We support projects using TypeScript versions >= 4.0.3. Read more about the benefits of TypeScript support in this FAQ.

Set Up Development Environment

Install dependencies

npm install

Build

You can create a minified or non-minified build:

npm run build

This command creates a minified, production-ready build at dist/plivobrowsersdk.min.js.

npm run build:nominify

This command creates a non-minified version of the build file at dist/plivobrowsersdk.js.

Start the development server

npm start

This command builds the SDK file and attaches it to port 9000 — http://localhost:9000/plivobrowsersdk.js. The project uses a webpack-dev-server that helps with live reloading. Whenever there is a change in any file, it auto builds.

If you use this server in plivo-browser-sdk2-examples, the app will auto-reload the build with the latest changes.

Testing

Unit tests

No extra setup is required for running unit tests. You can run unit tests with the command

npm run test:unit

Integration tests

Running integration tests requires some setup:

  • To perform test calls, you need two users. Create a .env file in the root directory of this repository and update it with primary and secondary user details as below:
PLIVO_ENDPOINT1_USERNAME=<Endpoint-1 Username>
PLIVO_ENDPOINT1_PASSWORD=<Endpoint-1 Password>
PLIVO_ENDPOINT2_USERNAME=<Endpoint-2 Username>
PLIVO_ENDPOINT2_PASSWORD=<Endpoint-2 Password>
  • After the setup, you can run integration tests by running the command
npm run test:integration

License

See LICENSE