The Relay SDK for Node.js enables Node.js developers to connect and use SignalWire's Relay APIs within their own Node.js code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications.
Read the implementation documentation, guides and API Reference at the official Relay SDK for Node.js Documentation site.
Relay SDK for Node.js 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.
The Node.js SDK is a package inside the signalwire-node monorepo. To setup the dev environment follow these steps:
- Download the installer for the LTS version of Node.js. This is the best way to also install npm.
- Fork the signalwire-node repository and clone it.
- Create a new branch from
masterfor your change.
npm installto install global dependencies.
npm run setup nodeto prepare the Node.js package.
- Navigate into the Node directory with
- Make changes!
Relay SDK for Node.js follows Semantic Versioning 2.0 as defined at http://semver.org.