Skip to content

Func Spec_index

dh_megane edited this page Feb 2, 2019 · 1 revision

一覧表示機能(index)

画面レイアウト

ShowProjectList_Ver1.2

明細項目説明(カッコ内はデータ取得元)

*太字はAPIで取得する情報

  • タイトル(サービス側でプロジェクト登録時に設定したタイトル)
  • 言語(GitHubで設定した言語:language
  • タグ(GitHubで設定したtopics:topics)
  • 簡易説明文(GitHubで設定した説明文:description)
  • ★Star(GitHubでのStar数:stargazers_count
  • 👥contributors(GitHubでのcontributors数:contributorsを集計)*Collaboratorsに変更するかも?
  • リンクLink
    • 他人が作成したプロジェクトの場合:「VIEW PROJECT」*プロジェクト個別表示画面
    • 自分が作成したプロジェクトの場合:「EDIT PROJECT」*プロジェクト投稿画面へ遷移)

機能説明

検索機能

1次リリースでは検索機能は実装しない。

プロジェクト投稿画面へ遷移(新規モード)

「NEW PROJECT」ボタンを押下すると、プロジェクト投稿画面を新規モードで開く。

プロジェクト投稿画面へ遷移(編集モード)

「EDIT PROJECT」リンクを押下すると、プロジェクト投稿画面を編集モードで開く。

プロジェクト個別表示画面へ遷移

「VIEW PROJECT」リンクを押下すると、プロジェクト個別表示画面を開く。

内部設計(詳細設計)

  • 表示(MVCで言うVIEW)の部分は「Vue.js」を使用する予定
  • APIで情報を取得するタイミングは下記の案がある。*APIを叩くときは並列で処理したい
    • createt、editは GitHub APIを叩き、キャッシュを更新する。
    • index、showは GitHub APIは叩かず、キャッシュを参照する。*キャッシュ保存期限は1時間など。

1次リリース後に機能追加予定

  1. 1行に2明細を表示する(ウインドウ幅が狭くなった場合は1明細で表示・リサイズする)
  2. キーワード検索(タイトル検索か?)
  3. ページネーション
  4. ソート機能/フィルター機能