# キックオフメモ
テーマ「めがはなせない」ということで、エンジニアウケしそうなRustに関するコンテンツをリアルタイムで配信するプラットフォームをKotlinで作っていきます。

## バックログ

1. - [ ] WebSocket機能の繋ぎ込み（react）
2. - [ ] メッセージのコンポーネントに名前をつける（Anonymous)
3. - [ ] 配信画面の表示
4. - [ ] 進捗バー表示

### 追加作業の仕様

/POST /channel/create

REQUEST

{
"client_id":適当なID
}

RESPONSE

{
"stream_url":"https://example.com",
"playback_url":"https://example.com",
"secret":"example-token"
}

### assign

- notch_man
- [ ] 1
- [ ] 2
- [ ]
- nissie
- [ ] 3
- y.tanak

## めがはなせないコンテンツ

- RustでISUCON用Webアプリのリプレイス
- ISUCON用Webアプリ＝[catatsuy/private-isu](https://github.com/catatsuy/private-isu)（catatsuyさんが作った社内向けISUCON）

## めがはなせないプラットフォーム

４つの機能
- メインはコーディングしている画面（画面共有）
- 視聴者と配信者をつなぐチャット
- 進捗を知らせる進捗バー（GitHubAPIからIssueの状態より計算）
- 配信部屋を生成するための配信者ログイン管理機能

## 画面遷移図

## ユースケース（仕様的なもの）

**配信者視点（ログイン必要）**
1. ユーザー登録をします。
2. 登録にはAuth0を用います。
3. ユーザーIDから配信URLを生成。遷移図左上の配信URL一覧に表示。
4. ログイン状態で配信URLへアクセスし遷移図左下の画面へ
5. 配信用の情報がモーダルで表示される。モーダルである必要性は特にない。
7. 配信を開始すると画面遷移図の右下に遷移する。
8. 共有されている画面の内容がわかる。
9. 音も共有できる！

**視聴者視点（アカウント概念なし）**

1. 遷移図左上の配信URLリストから任意のURLをクリック。
2. 遷移図右上に遷移し、配信を見たり待機したりできる。
3. チャットで自由に配信者にメッセージを送れる。（すべてのユーザーに公開される）
4. 進捗バーから配信者の進捗がわかる

**補足**

進捗バーに関して、GitHubのIssueの状態から計算します。例えばIssue数が4でcloseが1、openが３なら２５％の進捗度。Issue数が１０でcloseが8、openが2なら８０％の進捗度とします。

## 技術要素
- ストリーミング(RTMP)
- WebSocket

### フロントエンド
- React
- TypeScript
- Vite
- Node.js

### バックエンド
- Kotlin
- Ktor
- Node.js

### インフラ
- AWS
- Auth0
- Kubernetes

### AWS
- Amazon IVS
- Amazon EKS
- Amazon ECR
- Amazon VPC

## リポジトリ一覧

バックエンド：https://github.com/hackz-hackathon-ichthyo/Oracle-no-oubou-wo-yurusuna-back
フロントエンド（配信者用）：https://github.com/hackz-hackathon-ichthyo/Oracle-no-oubou-wo-yurusuna-front
フロントエンド（視聴者用）：https://github.com/hackz-hackathon-ichthyo/Oracle-no-oubou-wo-yurusuna-front2
コンテンツ：https://github.com/Romira915/private-isu

## デプロイ戦略

フロントエンドとバックエンドのデプロイ戦略について基本的にmainから作業ブランチを生やして開発を進めます。ローカル内で全ての検証ができる想定です。PRをmainにマージしたらStaging環境にデプロイされます。Stagingで問題が発生した場合はリバート対応します。正常に動作したmainブランチ上のコミットをタグづけしてタグをプッシュすることによりProduction環境にデプロイされます。問題が発生した場合は前回成功したProductionデプロイのワークフローを再実行してロールバックさせます。

## テスト配信用の配信サーバー情報
https://hackz-hackathon-team.slack.com/archives/C03DT3UFM6C/p1655298777178419

## streamerが初めてサービスに訪れてログインし、配信を開始するまでのフロー（v1.1）

## viewerが初めてサービスに訪れて、任意の配信を視聴開始するまでのフロー（v1）