highwave-rtc_sdk v2.0.4
Sinch RTC SDK - JavaScript
Sinch SDK for javascript
Setting Up the Development Environment
Pre-requisites:
- Install nodejs, download at https://nodejs.org/en/
In the root of this repository run:
make sync
This will
- Sync git submodules.
- Set up npm environment https://www.npmjs.com/
When the script finishes, it should be possible to run.
make serve
this will build the sdk and start a local http server on port 5050 if everything works you should be able to load http://localhost:5050/demo/
Build and Test Sdk
Build
make build
Generate ocra api from ocra design
make ocra
Build and start local http server
make serve
Tests
make test
Create the jssdk package
make dist
E2E Smoke test
Build Sdk for E2E smoke test
make bidiro
Build and start local host for running test host app
make bidiro-serve
This will start a local webserver at port 1080 and a WebSocket proxy listening on port 3000. To run the test host app use http://localhost:1080/sinch/{channel}/?sdk={sdk}
{channel} is an identifier for the channel and can be any string. WebSocket message to this app should be sent to http://{host}:3000/bidiro/{channel}
{sdk} is the folder where the sdk is located. By defaulr {sdk} is "sdk" which is the folder where the local built (make bidiro) sdk is located.
Design
For design document, see design/README.md