Socket
Socket
Sign inDemoInstall

@signalwire/realtime-api

Package Overview
Dependencies
64
Maintainers
9
Versions
109
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @signalwire/realtime-api

SignalWire RealTime SDK for Node.js


Version published
Weekly downloads
2.7K
increased by4.36%
Maintainers
9
Install size
6.79 MB
Created
Weekly downloads
 

Readme

Source

@signalwire/realtime-api

RELAY RealTime SDK

Build Status NPM

The RealTime SDK enables Node.js developers to connect and use SignalWire's RealTime APIs within their own Node.js code. Our RealTime 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 RealTime SDK Documentation site.


Contributing

SignalWire RealTime SDK 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 RealTime SDK is a package inside the signalwire-js monorepo. To setup the dev environment follow these steps:

  1. Download the installer for the LTS version of RealTime. This is the best way to also install npm.
  2. Fork the signalwire-js repository and clone it.
  3. Create a new branch from main for your change.
  4. Run npm install to install global dependencies.
  5. Navigate into the realtime-api directory with cd packages/realtime-api.
  6. Make changes!

Versioning

SignalWire RealTime SDK follows Semantic Versioning 2.0 as defined at http://semver.org.

License

@signalwire/realtime-api is copyright © 2018-2023 SignalWire. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

Keywords

FAQs

Last updated on 17 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc