Skip to content
shimewtrPublic

About

No description, website, or topics provided.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Repository files navigation

Comet ☄️

Comet — Real-time comments and stamps for presentations

Cometは、プレゼンテーションや配信へリアルタイムにコメントとスタンプを重ねて表示するシステムです。

参加者がWebアプリから投稿すると、同じRoomに接続したChrome拡張またはmacOSアプリへWebSocketで配信され、スライドやデスクトップ上を流れるリアルタイムオーバーレイとして表示されます。

主な機能

  • コメントとスタンプのリアルタイム配信
  • 一時的なRoomの作成と参加URL・QRコードの共有
  • カスタムスタンプのアップロード、検索、削除
  • コメント・スタンプ履歴の集計と表示
  • Chrome拡張によるGoogleスライド上のオーバーレイ
  • macOSアプリによる対象ディスプレイ全体へのクリック透過オーバーレイ
  • macOSアプリから進行する、絵文字スタンプ投票と結果グラフ
  • 任意で有効化できるOIDC認証
  • CloudFront + S3によるWeb配信とAWS CDKによるインフラ管理
flowchart LR
    User[参加者] --> Web[Webアプリ<br>CloudFront + S3]
    Web -- コメント・スタンプ --> WS[API Gateway WebSocket]
    WS --> Lambda[WebSocket Lambda]
    Lambda --> DDB[(DynamoDB)]
    Lambda -- Room内へ配信 --> Extension[Chrome拡張]
    Lambda -- Room内へ配信 --> Mac[macOSアプリ]
    Extension --> Slides[Googleスライド<br>オーバーレイ]
    Mac --> Desktop[全画面・スライド<br>オーバーレイ]
    Web -- カスタムスタンプ --> StampAPI[Stamp API]
    StampAPI --> StampStore[(S3 + DynamoDB)]
Loading

クイックスタート

必要な環境はNode.js 24 LTSとpnpm 10です。Node.jsの正確なバージョンは.node-versionを参照してください。

pnpm install
pnpm --filter @comet/shared build
pnpm --filter @comet/web dev

Webアプリは通常 http://localhost:5173 で起動します。AWS上のWebSocketやスタンプAPIへ接続する場合は、packages/web/.env.local に接続先を設定してください。

VITE_WEBSOCKET_URL=wss://example.execute-api.ap-northeast-1.amazonaws.com/prod
VITE_STAMP_API_URL=https://example.execute-api.ap-northeast-1.amazonaws.com

詳しいセットアップはローカル開発ガイドを参照してください。

macOSアプリ

macOS 14以降では、メニューバー常駐アプリ「Comet」を使ってコメントとスタンプをディスプレイ全体へ表示できます。Chromeに限定されないため、KeynoteやPowerPointのフルスクリーンスライド、配信画面などにもクリック透過のオーバーレイを重ねられます。出力するディスプレイ、コメント速度、サイズ、不透明度、表示領域、参加用QRコード、発表用タイマー、絵文字スタンプ投票を設定できます。

開発版を直接起動するにはApple Swift 6以降を用意し、次を実行します。

swift run --package-path packages/macos-app CometOverlay

ApplicationsやSpotlightから起動できる未署名アプリを作る場合は、Universal BinaryのComet.appを生成します。

scripts/build-macos-app.sh
open build/macos/Comet.app

起動後は次の手順で接続します。

  1. メニューバーのCometアイコンを開き、WebアプリURLを入力する
  2. 「接続する」を押す
  3. Roomと出力先ディスプレイを選択する
  4. 「オーバーレイを表示」をオンにする
  5. 参加者へ投稿先を案内する場合は「参加用QRコードを表示」をオンにする
  6. 発表時間を表示する場合は「タイマーを表示」をオンにし、画面上のタイマーへポインタを重ねて時間を調整してから再生ボタンを押す
  7. 投票を行う場合は「投票を開始…」からタイトル・時間・ラベルを設定する。参加者は表示された 1️⃣〜8️⃣ のスタンプを送るだけで投票できる

ツールバーアイコン右下のドットは、緑が接続済み、オレンジが接続中、赤が接続エラー、グレーが未接続を表します。認証が有効なWeb環境では、接続時にシステムブラウザでOIDC認証を行います。

設定、テスト表示、マルチディスプレイ、認証の詳細はmacOSアプリガイド、署名・Notarization・インストール方法は配布ガイドを参照してください。

ドキュメント

パッケージ

パッケージ 内容
packages/shared 型、定数、バリデーション、共通WebSocketクライアント
packages/web React + Viteの投稿・履歴Webアプリ
packages/chrome-extension Manifest V3のオーバーレイChrome拡張
packages/macos-app macOS全画面オーバーレイアプリ
packages/api/websocket-handler WebSocket接続・Room・メッセージ処理Lambda
packages/api/stamp-upload カスタムスタンプAPI Lambda
packages/api/history-handler Room履歴・集計API Lambda
packages/edge-auth Lambda@EdgeのOIDC認証処理
packages/cdk AWS CDKのインフラ定義

よく使うコマンド

pnpm build
pnpm test
pnpm lint

GitHub ActionsはPull Requestとmainへのpushでbuild、lint、test、CDK synthを実行します。AWSへのデプロイは行いません。

ライセンス

MIT License

About

No description, website, or topics provided.

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages