{"id":23853577,"url":"https://github.com/openayame/ayame-web-sdk","last_synced_at":"2025-07-29T05:05:06.904Z","repository":{"id":34923257,"uuid":"190844988","full_name":"OpenAyame/ayame-web-sdk","owner":"OpenAyame","description":"Ayame Web SDK","archived":false,"fork":false,"pushed_at":"2025-07-28T16:30:09.000Z","size":4916,"stargazers_count":25,"open_issues_count":1,"forks_count":14,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-07-28T18:33:12.878Z","etag":null,"topics":["javascript","sdk","typescript","webrtc"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OpenAyame.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-06-08T04:26:23.000Z","updated_at":"2025-07-28T16:30:13.000Z","dependencies_parsed_at":"2024-01-30T21:43:59.057Z","dependency_job_id":"8265eef9-aacb-4be9-9a56-324bd63804d0","html_url":"https://github.com/OpenAyame/ayame-web-sdk","commit_stats":{"total_commits":330,"total_committers":9,"mean_commits":"36.666666666666664","dds":0.6909090909090909,"last_synced_commit":"f073fa4a93a1dc89fe95a69e7fbbe271902c26a9"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/OpenAyame/ayame-web-sdk","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAyame%2Fayame-web-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAyame%2Fayame-web-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAyame%2Fayame-web-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAyame%2Fayame-web-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OpenAyame","download_url":"https://codeload.github.com/OpenAyame/ayame-web-sdk/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OpenAyame%2Fayame-web-sdk/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267632859,"owners_count":24118749,"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","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["javascript","sdk","typescript","webrtc"],"created_at":"2025-01-02T23:18:02.366Z","updated_at":"2025-07-29T05:05:06.885Z","avatar_url":"https://github.com/OpenAyame.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebRTC Signaling Server Ayame Web SDK\n\n[![npm version](https://badge.fury.io/js/%40open-ayame%2Fayame-web-sdk.svg)](https://badge.fury.io/js/%40open-ayame%2Fayame-web-sdk)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Actions Status](https://github.com/OpenAyame/ayame-web-sdk/workflows/Lint%20And%20Flow%20Test/badge.svg)](https://github.com/OpenAyame/ayame-web-sdk/actions)\n\n## About Shiguredo's open source software\n\nWe will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.\n\nPlease read \u003chttps://github.com/shiguredo/oss\u003e before use.\n\n## 時雨堂のオープンソースソフトウェアについて\n\n利用前に \u003chttps://github.com/shiguredo/oss\u003e をお読みください。\n\n## 概要\n\n[WebRTC Signaling Server Ayame](https://github.com/OpenAyame/ayame) をブラウザから利用する SDK です。\n\n## 使い方\n\n### npm\n\n```bash\nnpm install @open-ayame/ayame-web-sdk\n```\n\n### pnpm\n\n```bash\npnpm add @open-ayame/ayame-web-sdk\n```\n\n## 動作環境\n\n最新のブラウザを利用してください。\n\n- Google Chrome\n- Apple Safari\n- Mozilla Firefox\n- Microsoft Edge\n\n## Ayame DevTools\n\nAyame Web SDK を利用した、開発ツールです。\n\n- [Ayame Labo](https://ayame-labo.shiguredo.app/) を利用する例です\n- `GitHub ログイン名@ayame-devtools` というルーム ID にしていますが、ルーム名の `ayame-devtools` は任意の文字列に変更できます\n- シグナリングキーは [Ayame Labo](https://ayame-labo.shiguredo.app/) のダッシュボード上で取得してください\n\n```bash\n# cp .env.template .env.local\nVITE_AYAME_SIGNALING_URL=wss://ayame-labo.shiguredo.app/signaling\nVITE_AYAME_ROOM_ID_PREFIX={GitHubログイン名}@\nVITE_AYAME_ROOM_NAME=ayame-devtools\nVITE_AYAME_SIGNALING_KEY={シグナリングキー}\n```\n\n```bash\npnpm install\npnpm build\npnpm dev\n```\n\n\u003chttp://localhost:5173/\u003e にアクセスすると、以下のような画面が表示されます。\n\n[![Image from Gyazo](https://i.gyazo.com/69b1e9529f1a0e26bd3bcd3b74c95021.png)](https://gyazo.com/69b1e9529f1a0e26bd3bcd3b74c95021)\n\nこの画面を 2 つタブで開いて、 `Connect` ボタンを押して映像が双方向に表示されたら成功です。\n\n### オンライン Ayame DevTools\n\n以下から利用できます。\n\n\u003chttps://openayame.github.io/ayame-web-sdk/devtools/index.html\u003e\n\n## 最小限のサンプル\n\n[OpenAyame/ayame-web-sdk-examples](https://github.com/OpenAyame/ayame-web-sdk-examples) に最小限のサンプルコードを用意しています。\n\n## API ドキュメント\n\nAPI ドキュメントは以下の URL を参照してください。\n\n\u003chttps://openayame.github.io/ayame-web-sdk/typedoc/index.html\u003e\n\n## ライセンス\n\nApache License 2.0\n\n```text\nCopyright 2019-2025, Shiguredo Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenayame%2Fayame-web-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenayame%2Fayame-web-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenayame%2Fayame-web-sdk/lists"}