読み方のヒント

矢印ボタン(または ← → キー)でページを移動できます。

第5節 READMEと制作記録

5.1 README に書くこと

READMEは、プロジェクトのフォルダの一番上に置く、最初に読む説明の文書です。

項目内容
何のアプリかこもれびベーカリーの予約アプリ(教材の練習用、架空のデータ)
できること商品の一覧、ログイン、予約、自分の予約の一覧と絞り込み、キャンセル、店員の受け取り
できないこと(既知の制約)支払い、利用者の登録、パスワードの再発行、ログインの試行回数の制限
構成画面、API、データベースの図
起動の手順公開の章でまとめた手順
テストの実行APIのテスト、関数のテスト、画面のテストの命令
秘密の値.env は含めない。.env.example から作る

「できないこと」も書きます。読んだ人が、このアプリをそのまま実際の店で使えると誤解しないためです。

18 / 20