SkyWay JavaScript SDK

Using the SDK

$3

Add the following script tag to your html file.

``html

`

You can then use the Peer object to start connecting.
For more details, check out the Tutorial. (日本語)

To use the compressed version, add .min to the end of the file name, like skyway-4.4.5.min.js.

$3

With npm installed, run

$ npm install -s skyway-js

You can then use require or import to import the package.

`js
// require
const Peer = require('skyway-js');
const peer = new Peer({key: 'your-api-key'});

// import
import Peer from 'skyway-js';
const peer = new Peer({key: 'your-api-key'});
`

Docs

- API reference(日本語)
- Tutorial(日本語)
- Sample Code

Examples

You can use /examples directory for checking your development code.

Follow these steps.

- Modify your key
- e.g.) sed -i -e "s//12341234-abcd-1234-abcd-1234567890ab/g" examples/_shared/key.js
- The key can be obtained from https://webrtc.ecl.ntt.com/en/ .
- Start server on project root
- e.g.) python -m SimpleHTTPServer 8000

Contributing

$3

Make sure you have nodejs installed. Run npm install to get started and to set up dependencies.

`sh


run eslint

npm run lint

run all unit tests

npm run test # OR npm test OR npm t

build the library

npm run build
`

After making changes in src/, you run

- npm run lint to validate
- npm test to run tests

then the npm run build and build skyway(.min).js which is stored in dist directory!

$3

* check if you can reproduce in the latest version
* check the FAQ and the forum to make sure the same issue has not already been reported.
* create an issue by filling in the template.

$3

* We welcome suggestions on the developer community forums
* GitHub issues are primarily intended for bug reports/fixes

$3

* We do our best to process them quickly but please be understanding if we take a while to respond.
* Steps
* make changes on your fork.
* include clear descriptions and references to all the issues by filling the template.
* submit tests for your changes.
* update docs when creating or changing features.
* make sure the test suite & lint passes.

`
npm run lint
npm run test
`

* Branch
* send all pull requests (bug fixes, new features) to the master branch.
* maintainers will change it to an appropriate branch.

$3


#### Issue
`

Description of the problem

Environment

- SDK version (ex. SDK v1.0.1,etc)
- Device (ex. Windows PC, Nexus6, etc)
- OS (ex. Windows XX / Android 7.0 etc)
- Network (Cable/DSL/Fiber + WiFi, MiFi, LTE, etc)

Steps to reproduce the problem

Expected behavior

Other information (Console log etc)

`
#### PR
`


Description of the Change

Benefits

Possible side effects

Relevant Issues

``