@signalwire/node
    TypeScript icon, indicating that this package has built-in type declarations

    2.5.0 • Public • Published

    SignalWire Node.js

    Build Status NPM

    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.

    Getting Started

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


    Contributing

    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.

    Developers

    The Node.js 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 node to prepare the Node.js package.
    6. Navigate into the Node directory with cd packages/node.
    7. Make changes!

    Versioning

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

    License

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

    Install

    npm i @signalwire/node

    DownloadsWeekly Downloads

    1,366

    Version

    2.5.0

    License

    MIT

    Unpacked Size

    309 kB

    Total Files

    190

    Last publish

    Collaborators

    • egallo
    • startledmarmot