SignalWire React Native
The Relay SDK for React Native enables developers to connect and use SignalWire's Relay APIs within their own React Native apps. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications.
Getting Started
To install this package in your project, use the following command:
npm install @signalwire/react-native @react-native-async-storage/async-storage
The @react-native-async-storage/async-storage
package is a peerDependency so it must be manually installed.
WebRTC Engine
Our package @signalwire/react-native
depends on react-native-webrtc and will try to install it automatically for you in the postinstall
script.
It's possible that an error will occur during the linking process of the native libraries. If your app does not compile, follow these steps to troubleshoot:
Make sure to check the app permissions in
AndroidManifest.xml
andInfo.plist
to access the device camera and microphone!
Contributing
Relay SDK for React Native 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 React Native 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
master
for your change. - Run
npm install
to install global dependencies. - Run
npm run setup react-native
to prepare the React Native package. - Navigate into the react-native directory with
cd packages/react-native
. - Make changes!
Versioning
Relay SDK for React Native follows Semantic Versioning 2.0 as defined at http://semver.org.
License
Relay SDK for React Native is copyright © 2018-2019 SignalWire. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.