VideoQ 開発ドキュメント
VideoQ は、動画の内容に質問し、根拠となる場面へすぐに戻れる学習アプリです。動画を講座にまとめて共有し、Q&Aや問い・ヒントを使った学習に利用できます。
このサイトは、初めて開発に参加する人が、アプリを動かし、小さな変更を進められるようにするための案内です。すべての設計図を先に読む必要はありません。
初めて参加したら
次の順に進めると、使い方と実装が結び付きます。
| 順番 | 読むページ | ここまでできれば次へ |
|---|---|---|
| 1 | 開発環境を動かす | ローカルにログインできる |
| 2 | 動画を登録して質問する | 回答の引用から動画の場面へ戻れる |
| 3 | コードの場所を知る | 画面・API・動画処理の担当場所が分かる |
| 4 | 最初の変更を進める | 小さな変更と、その確認結果をレビューに出せる |
文書だけの変更なら、ドキュメントを更新するから始められます。
まず知っておくこと
- 動画は1本の教材、講座は質問・共有の対象となる動画のまとまりです。データの関係を見る
- 画面はReact、APIはHono、時間のかかる動画処理はPythonが担当します。全体像を見る
- 動画の文字起こし・検索準備・学習用データの作成は順に進みます。登録直後にすべて使えるわけではありません。状態の意味を見る
作業に合わせて読む
| やりたいこと | ガイド |
|---|---|
| 画面・文言・フォームを変える | 画面を変更する |
| 取得・更新するデータや操作を増やす | APIを変更する |
| テーブルや列を変更する | DBを変更する |
| 文字起こし・索引・学習データを変える | 動画の非同期処理を変更する |
| 変更が正しいか確かめる | テストと確認コマンド |
| 起動や動画処理で困っている | 困ったとき |
詳しく調べる
必要になったときに、左の「設計リファレンス」から各図や仕様を参照してください。DBの名前はデータ辞書、略語は用語集で確認できます。