codeforjapan / codeforjapan/StudyAtHome

URL・クエリパラメータ等の整理

Open
#163 33 comments 0 reactions 1 assignee Claimed by @MaySoMusician View on GitHub
pages
Dominant language
Vue
Stars
31
Forks
19
PR merge metrics
No merged PRs in 30d

Description

時間割を見るだけのページ(生徒側を想定。以下「生徒役」ユーザー)と、時間割の編集が可能なページ(教員側を想定。以下「教員役」ユーザー)でURLを大別するとわかりやすいのではないか。

- ルートディレクトリ: 生徒役・教員役共通のページ
- `/`: サービストップページ(兼 生徒役ログインページ)
- `/terms`: 利用規約(閲覧のみ)ページ(現 `/policy` から `/terms` に変更予定 )
- `/about`: 紹介ページ?
- `/student` ディレクトリ: 生徒役用のページ群
- `/student`: 時間割ページ(現 `/classes` )
- `/student/lesson?id=`: 各授業の詳細ページ(現 `/lesson` )
- `/teacher` ディレクトリ: 教員役用のページ群
- `/teacher/login`: 教員役ログインページ(現 `/account/login` )
- `/teacher/signup`: 教員役登録ページ(現 `/user/signup` )
- `/teacher/signup/agree`: 教員役 登録時利用規約同意ページ(現 `/terms` から `/agree` に変更予定 )
- ※ この階層構造が不可能そうなら `/teacher/agree`
- `/teacher/reset-password`: 未使用・パスワードリセット(現 `/account/resetPassword` )
- ※ 名前の候補としては `usernamerecovery` `forgotpassword` `reset` など
- `/teacher/edit`: 時間割を見て授業を登録したり編集したりするページ(現 `/edit` )
- `/teacher/classes/new`: 新クラス登録ページ(現 `/user/registerClass` )
- `/teacher/classes/success`: 新クラス登録完了ページ(現 `/user/registered` )
- `/teacher/classes/select`: クラス一覧・選択ページ(現 `/user/classlist` )

各ページ名は

- 連結文字無し
- kebab-case
- UpperCamelCase(PascalCase)

が良いと思われる。lowerCamelCaseの例はあまり見られず、またnon-techなユーザーにはこのようなキャピタライズは自然に見えないだろう。
どのサイトでも、そもそも単語が複数にならないような工夫をしていた。

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.