@signalwire/js

SignalWire JavaScript SDK v1

:warning: For the latest version of the JavaScript SDK, please see signalwire/signalwire-js.

The JavaScript SDK transforms your standard browser into a realtime media engine, enabling developers to directly make audio and video calls to phone numbers, SIP endpoints, and other browsers. Using the JavaScript SDK you can add immersive, scalable communication - from video conferences and softphones to click-to-call and mobile gaming - all available right in your own web pages and applications.

Getting Started

Read the implementation documentation, guides and API Reference at the official Relay SDK for JavaScript Documentation site.

---

Contributing

Relay SDK for JavaScript is open source and maintained by the SignalWire team, but we are very grateful for everyone who has contributed and assisted so far.

If you'd like to contribute, feel free to visit our Slack channel and read our developer section to get the code running in your local environment.

Developers

The JavaScript SDK is a package inside the signalwire-node monorepo. To setup the dev environment follow these steps:

1. Download the installer for the LTS version of Node.js. This is the best way to also install npm.
2. Fork the signalwire-node repository and clone it.
3. Create a new branch from master for your change.
4. Run npm install to install global dependencies.
5. Run npm run setup js to prepare the JavaScript SDK.
6. Navigate into the JavaScript directory with cd packages/js.
7. Make changes!

Versioning

Relay SDK for JavaScript follows Semantic Versioning 2.0 as defined at http://semver.org.

License

Relay SDK for JavaScript is copyright © 2018-2019 SignalWire. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.