{"id":21514977,"url":"https://github.com/skyway/skyway-js-sdk","last_synced_at":"2025-04-12T18:47:56.316Z","repository":{"id":39800881,"uuid":"102436510","full_name":"skyway/skyway-js-sdk","owner":"skyway","description":"JavaScript SDK for SkyWay","archived":false,"fork":false,"pushed_at":"2023-01-31T03:24:30.000Z","size":3008,"stargazers_count":188,"open_issues_count":0,"forks_count":173,"subscribers_count":21,"default_branch":"master","last_synced_at":"2025-04-03T21:12:41.636Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/skyway.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null}},"created_at":"2017-09-05T05:06:58.000Z","updated_at":"2024-10-14T12:13:37.000Z","dependencies_parsed_at":"2023-02-16T15:15:59.636Z","dependency_job_id":null,"html_url":"https://github.com/skyway/skyway-js-sdk","commit_stats":null,"previous_names":[],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-js-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-js-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-js-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skyway%2Fskyway-js-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skyway","download_url":"https://codeload.github.com/skyway/skyway-js-sdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248617832,"owners_count":21134197,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T23:53:45.899Z","updated_at":"2025-04-12T18:47:56.279Z","avatar_url":"https://github.com/skyway.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SkyWay JavaScript SDK\n\n**This is the old SkyWay repository.  Please consider migrating to the [new SkyWay](\u003chttps://skyway.ntt.com\u003e).**\n\n**これは旧SkyWayのリポジトリです。[新しいSkyWay](\u003chttps://skyway.ntt.com\u003e)への移行をご検討ください。**\n\n---\n\n## Using the SDK\n\n### Including the sdk from the CDN in your html\n\nAdd the following script tag to your html file.\n\n```html\n\u003cscript type=\"text/javascript\" src=\"https://cdn.webrtc.ecl.ntt.com/skyway-4.4.5.js\"\u003e\u003c/script\u003e\n```\n\nYou can then use the `Peer` object to start connecting.\nFor more details, check out the [Tutorial](https://webrtc.ecl.ntt.com/en/js-tutorial.html). ([日本語](https://webrtc.ecl.ntt.com/js-tutorial.html))\n\nTo use the compressed version, add `.min` to the end of the file name, like `skyway-4.4.5.min.js`.\n\n### Installing using npm to use with a bundler (e.g. webpack or browserify)\n\nWith [npm](https://npmjs.org/) installed, run\n\n    $ npm install -s skyway-js\n\nYou can then use `require` or `import` to import the package.\n\n```js\n// require\nconst Peer = require('skyway-js');\nconst peer = new Peer({key: 'your-api-key'});\n\n// import\nimport Peer from 'skyway-js';\nconst peer = new Peer({key: 'your-api-key'});\n```\n\n## Docs\n\n- [API reference](https://webrtc.ecl.ntt.com/en/js-reference/)([日本語](https://webrtc.ecl.ntt.com/js-reference/))\n- [Tutorial](https://webrtc.ecl.ntt.com/en/js-tutorial.html)([日本語](https://webrtc.ecl.ntt.com/js-tutorial.html))\n- [Sample Code](https://github.com/skyway/skyway-js-sdk/tree/master/examples/)\n\n## Examples\n\nYou can use `/examples` directory for checking your development code.\n\nFollow these steps.\n\n- Modify your key\n  - e.g.) `sed -i -e \"s/\u003cYOUR_KEY_HERE\u003e/12341234-abcd-1234-abcd-1234567890ab/g\" examples/_shared/key.js`\n  - The key can be obtained from https://webrtc.ecl.ntt.com/en/ .\n- Start server on project root\n  - e.g.) `python -m SimpleHTTPServer 8000`\n\n## Contributing\n\n### Setting up\n\nMake sure you have nodejs installed. Run `npm install` to get started and to set up dependencies.\n\n```sh\n# run eslint\nnpm run lint\n\n# run all unit tests\nnpm run test # OR npm test OR npm t\n\n# build the library\nnpm run build\n```\n\nAfter making changes in `src/`, you run\n\n- `npm run lint` to validate\n- `npm test` to run tests\n\nthen the `npm run build` and build `skyway(.min).js` which is stored in `dist` directory!\n\n### Bug Reports\n* check if you can reproduce in the latest version\n* check the [FAQ](https://support.skyway.io/hc/en-us/categories/204565748-FAQ) and the [forum](https://support.skyway.io/hc/en-us/community/topics) to make sure the same issue has not already been reported.\n* create an issue by filling in the template.\n\n### Feature requests, proposals\n* We welcome suggestions on the [developer community forums](https://support.skyway.io/hc/en-us/community/topics)\n* GitHub issues are primarily intended for bug reports/fixes\n\n### Pull Requests\n* We do our best to process them quickly but please be understanding if we take a while to respond.\n* Steps\n    * make changes on your fork.\n    * include clear descriptions and references to all the issues by filling the template.\n    * submit tests for your changes.\n    * update docs when creating or changing features.\n    * make sure the test suite \u0026 lint passes.\n\n```\nnpm run lint\nnpm run test\n```\n\n* Branch\n    * send all pull requests (bug fixes, new features) to the master branch.\n    * maintainers will change it to an appropriate branch.\n\n### Templates\n#### Issue\n```\n## Description of the problem\n\n## Environment\n- SDK version (ex. SDK v1.0.1,etc)\n- Device (ex. Windows PC, Nexus6, etc)\n- OS (ex. Windows XX / Android 7.0 etc)\n- Network (Cable/DSL/Fiber + WiFi, MiFi, LTE, etc)\n\n## Steps to reproduce the problem\n\n## Expected behavior\n\n## Other information (Console log etc)\n\n```\n#### PR\n```\n## Description of the Change\n\n## Benefits\n\n## Possible side effects\n\n## Relevant Issues\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyway%2Fskyway-js-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskyway%2Fskyway-js-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskyway%2Fskyway-js-sdk/lists"}