How kou050223/animeishi works
プロジェクトの種類と目的
• 本プロジェクトは「アニ名刺」というFlutter製のクロスプラットフォームアプリケーションです。
• 視聴したアニメ一覧を交換し、会話のきっかけにすることを目的としたSNS的要素をもつフルスタック(クライアント+バックエンド)アプリです。
• バックエンドにはFirebase(Authentication, Firestore, Hostingなど)を利用しています。
ファイル構造の概要
• プラットフォーム別コード:android/, ios/, linux/, macos/, windows/, web/
• 共通ビジネスロジック・UI:lib/ 以下
• lib/main.dart や lib/app.dart:エントリポイント
• lib/config/firebase_options.dart:Firebase初期化設定
• lib/model:ドメインモデルとファクトリ
• lib/ui:MVVM的構成(view/view_model)および共通コンポーネント
• テスト:test/widget_test.dart
• Firebase 設定:firebase.json, .firebaserc, firestore.rules, firestore.indexes.json
READMEから得られる補足
• 「アニ名刺」は主にアニメ視聴履歴をFirestoreで管理し、ユーザー同士で交換・共有する機能を持つ。
• 使用技術:Flutter, Firebase
システムデザイン図作成のガイドライン
a. 主なコンポーネントを洗い出す
• クライアントアプリ(Flutter)
・UI レイヤ(view)
・ビジネスロジック/状態管理(view_model)
・データモデル(model)
・共通コンポーネント(background_animation, カメラ/QR などプラグイン)
• バックエンド(Firebase)
・Authentication
・Cloud Firestore
・Hosting(Web版用)
・Optional: Cloud Functions(拡張用)
• 外部ライブラリ/サービス
・camera, qr_code_scannerプラグイン
・state_notifier等の状態管理ライブラリ
b. コンポーネント間の関係とデータフロー
• Flutter UI ←→ ViewModel:StateNotifer等で双方向バインド
• ViewModel → Firebase Auth:ログイン/サインアップ処理
• ViewModel → Firestore:ドキュメント CRUD(アニメ一覧、プロフィール、友達リストなど)
• Camera プラグイン → QR スキャン → ViewModel に結果渡し → Firestore へ保存
• Web 版は同じViewModelをFirebase Hosting経由で提供
c. 採用アーキテクチャ/設計原則
• MVVM パターン(view/view_model/model の三層)
• 単一責任の原則:factoryクラスはモデル生成のみ、view_modelは状態管理のみ
• プラットフォーム依存コードとビジネスロジックの分離
d. 主要技術スタック
• Flutter(Dart)
• Firebase Authentication / Firestore / Hosting
• state_notifier(または Riverpod など)
• camera, qr_code_scanner 等のネイティブプラグイン
図に必ず含める要素
• 各コンポーネントの明確なラベル(例:「Flutter Client」「Firestore DB」など)
• 方向付き矢印でデータフロー/依存関係を可視化
• 色分けまたは図形使い分け:
・クライアント層(青系)
・ビジネスロジック層(緑系)
・データ層/外部サービス(オレンジ系)
プロジェクト固有の注意点
• マルチプラットフォーム対応:各プラットフォームごとの起動フロー(android/app → MainActivity、ios/Runner → AppDelegate、web/index.html → main.dart)をサブフローで示すと詳細度が増します。
• Firebase 初期化:lib/config/firebase_options.dart に記載された環境別設定もアイコンや注釈で示すとよいでしょう。
• QR コード交換機能:カメラプラグイン→QR解析→Firestore 更新という流れを、コメント付きで明示する
図作成のポイント
• 全体像を俯瞰できるレイアウトを最初に配置し、下層に詳細フローを分割して描く
• 各レイヤーごとに矩形で囲み、レイヤ間インタフェースを太線で強調
• READMEにない内部モジュール(model/factory, view_model)も必ず表示し、責務を注記
• 将来の拡張ポイント(Cloud Functions, Push Notification など)は点線の枠で示し、拡張性をアピール
以上を踏まえ、プロジェクト専用のシステムデザイン図を作成してください。
細部まで分割し、コンポーネントとデータフローを明確に可視化することで、チーム全体の理解共有がスムーズになります。