リアルタイム通信を利用してブラウザでグラフを表示します。

measuring equipment --(WebSocket)--> deno deploy server --(BroadcastChannel)--> deno deploy server --(Server-Sent-Events)--> browser

https://socket-graph.deno.dev

⚠️実験的なプロジェクトです。使用しないでください。

• ./db/: データベース接続用のコード
• ./listeners/: サーバーの実装
• ./static/: ブラウザで使用する静的ファイルや、ブラウザとサーバーで共通のコード
• ./testdata: テストに使うファイル
• ./dev/: スピード計測や送信テストなどに用いたコード
• ./github/: GitHub Actionsの設定など
• ./allow_cors.json: 他サイトから読み込めるようにCORSヘッダーを付けるページのリスト（serve.tsによって制御）
• ./serve.ts: サーバーのエントリポイント
• ./serve_test: サーバーのテスト

• ディレクトリ全体をgitで管理しているのだが、その対象から外したいファイルを指定する
• 例えば.envファイルは個人情報やパスワードが書いてあるので、githubで公開されるのは困る。そのため、gitignoreしておく。

• 「環境変数」を設定するファイル
• ここで設定した環境変数は、プログラム上からのみ使うことができる。
• 例えば、.envファイルの中にPASSWORD="ひみつ"と書いておくと、プログラム上でconst pass = Deno.env.get("PASSWORD")でひみつという値が取得できる
• 知られたくない情報は全てここに書く（firebaseのアクセストークンなど）
• 主な環境変数
  • FIREBASE_CONFIG: ./database/mod.tsの中で使われる。firebaseのconfigについては https://firebase.google.com/docs/web/learn-more?hl=ja#config-object を参照。
  • DENO_SQLITE_PATH: sqliteのdllファイルへのパス（例えばC:/Users/azusa/socket-graph/db/sqlite_dll/sqlite3.dll）を指定する。

※環境変数を使う際は

1. .envファイル（ローカル開発で使う）
2. deno deployの環境変数（deno deployにログインして設定）
3. GitHub Actionsの環境変数（GitHubにログインして設定→secret→Actionsで追加）

の3種を必要に応じて設定・追加する。必要に応じて.github/workflow/ci.ymlの中にあるテストコマンドも変更する

• ライセンスが書いてある。MITライセンスです。

• テスト用のファイル
• deno test <ファイル名>コマンドでテストを実行できる。全てのテストに合格することが期待される。

https://deno.land/manual@main/getting_started/setup_your_environment このへんを参考に、エディタの拡張機能をインストールする必要あり

以下のコマンドをターミナルで打つ

deno run --allow-net -
-allow-read=. --allow-env --allow-ffi --unstable --watch ./serve
.ts

（またはdeno task serveコマンドを打つ）

その後、http://localhost:8000/ などにブラウザでアクセスする

• このサーバーは https://socket-graph.deno.dev というドメインから世界に公開されている
• deno deployというサービスを使っている
• GitHubにpushすると、自動でその変更が反映・公開されるようになっている
  • GitHubについては各自で調べてください
• deno deployにログインすると環境変数の設定やログの閲覧が行える。

コード中に/**(コメント)*/という形式のコメントが現れる。これはドキュメントコメントと呼ばれ、エディタや https://doc.deno.land でドキュメントを表示させることができるものである。

※GitHubのファイルのページに行き、rawボタンを押してrawファイルを開く。そのURLをコピーして https://doc.deno.land に入力するとドキュメントが表示される。

• Webサイトとして公開する場合
  • GitHubアカウント・deno deployアカウント・Firebaseアカウントの3つが必要です。ない場合は新しく作ってください。
  • https://github.com/ayame113/socket-graph の開発を引き継ぐことになります。
  • 方法1：リポジトリを転送します。deno deployやfirebaseのprojectも転送するので、 https://github.com/ayame113/socket-graph/issues などから@ayame113 に連絡ください。（多分こっちで手続きが必要なので）
  • 方法2：リポジトリをforkします（forkボタンを押す）。deno deployに再登録する必要があります。deno deployに登録して、./serve.tsをエントリポイントとして設定してください。
  • deno deployのプロジェクトも転送する必要があります。
• Webサイトとして公開しない場合
  • ここのコードをそのままコピーして使ってください。

サーバー側は弄らずに、測定機器の送信だけをやる場合は、上記の手続きは不要です。 https://socket-graph.deno.dev/ の説明を読んでください。

わからないことがあれば https://github.com/ayame113/socket-graph/issues にコメントするか直接聞いてください