Skip to content

Commit

Permalink
Merge pull request #584 from shiguredo/feature/remove-examples
Browse files Browse the repository at this point in the history
Feature/remove examples
  • Loading branch information
voluntas authored Jan 14, 2025
2 parents 501be03 + 58eaa3e commit 99090ec
Show file tree
Hide file tree
Showing 43 changed files with 71 additions and 2,612 deletions.
3 changes: 3 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@
- @voluntas
- [ADD] 新しい examples を追加する
- @voluntas
- [CHANGE] examples を削除する
- <https://github.com/shiguredo/sora-js-sdk-examples> へ移動
- @voluntas
- [CHANGE] Node.js 18 をビルドとテストから落とす
- @voluntas
- [CHANGE] examples を e2e-tests に変更する
Expand Down
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,21 @@ Please read <https://github.com/shiguredo/oss> before use.

利用前に <https://github.com/shiguredo/oss> をお読みください。

## 条件

- WebRTC SFU Sora 2024.1.0 以降
- TypeScript 5.1 以降

## 使い方

使い方は [Sora JavaScript SDK ドキュメント](https://sora-js-sdk.shiguredo.jp/) を参照してください。

## サンプル

サンプルは [sora-js-sdk-examples](https://github.com/shiguredo/sora-js-sdk-examples) を参照してください。

## インストール

### npm

```bash
Expand All @@ -33,11 +44,6 @@ npm install sora-js-sdk
pnpm add sora-js-sdk
```

## 条件

- WebRTC SFU Sora 2024.1.0 以降
- TypeScript 5.1 以降

### Node.js の条件

- Sora JavaScript SDK 2024.2.x までは **Node.js 18.0 以降** を要求します
Expand All @@ -50,18 +56,6 @@ pnpm add sora-js-sdk
> - Firefox 113 以降
> - Safari 16.4 以降
## サンプル

サンプルを Vite にて起動できます。

```bash
# .env.local を作成して適切な値を設定してください
$ cp .env.template .env.local
$ pnpm install
$ pnpm run build
$ pnpm run dev
```

## E2E (End to End) テスト

Playwright を利用した E2E テストを実行できます。
Expand Down
1 change: 1 addition & 0 deletions e2e-tests/data_channel_signaling_only/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>DataChannelSignalingOnly test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Sora JavaScript SDK example</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/recvonly/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Recvonly test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/sendonly/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Sendonly test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/sendonly_audio/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Sendonly Audio test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/sendrecv/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Sendrecv test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/simulcast/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Simulcast test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/spotlight_recvonly/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Spotlight Recvonly test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/spotlight_sendonly/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Spotlight Sendonly test</title>
</head>

Expand Down
1 change: 1 addition & 0 deletions e2e-tests/spotlight_sendrecv/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

<head>
<meta charset="utf-8">
<link rel="icon" href="data:,">
<title>Spotlight Sendrecv test</title>
</head>

Expand Down
3 changes: 1 addition & 2 deletions e2e-tests/whep/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="icon"
href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text x=%2250%%22 y=%2250%%22 style=%22dominant-baseline:central;text-anchor:middle;font-size:90px;%22>🤨</text></svg>">
<link rel="icon" href="data:,">
<title>Sora WHEP Client</title>
</head>

Expand Down
6 changes: 2 additions & 4 deletions e2e-tests/whip/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,8 @@

<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="icon"
href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text x=%2250%%22 y=%2250%%22 style=%22dominant-baseline:central;text-anchor:middle;font-size:90px;%22>🤨</text></svg>">
<title>Sora WHEP Client</title>
<link rel="icon" href="data:,">
<title>Sora WHIP Client</title>
</head>

<body>
Expand Down
13 changes: 0 additions & 13 deletions examples/README.md

This file was deleted.

54 changes: 0 additions & 54 deletions examples/check_stereo/index.html

This file was deleted.

Loading

0 comments on commit 99090ec

Please sign in to comment.