Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

簡略研修バージョン #280

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
Open

簡略研修バージョン #280

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d6a4796
super compact version
Apr 4, 2019
0b0521c
fix branch description
Apr 4, 2019
a156437
recover step4 as optional
Apr 5, 2019
3b05801
fix step no
Apr 5, 2019
58d3ade
add missing guide
Apr 11, 2019
ea45318
clarify optional items
k-kiosk Sep 1, 2021
f0db908
fix step no
k-kiosk Sep 1, 2021
5d984c7
delete unnecessary words
k-kiosk Sep 1, 2021
25bad2e
Merge pull request #1097 from Fablic/fix/curriculum
k-kiosk Sep 1, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
205 changes: 13 additions & 192 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

## このカリキュラムについて

この文書は、Fablicで必須とされるRuby on Railsとその周辺技術の基礎を習得するための新入社員教育用カリキュラムです。
この文書は、楽天株式会社ラクマ事業部で必須とされるRuby on Railsとその周辺技術の基礎を習得するための新入社員教育用カリキュラムです。
<details>
新入社員の能力によらず、必ず一通りのステップを実施していただきます。
研修期間は特に定めておりません。
すべてのステップを完了した時点で研修修了となります。
Expand All @@ -20,6 +21,7 @@
このカリキュラムは[クリエイティブ・コモンズ 表示 - 非営利 - 継承 4.0 国際 ライセンス](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.ja)の下に提供されています。

[![クリエイティブ・コモンズ・ライセンス](https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png)](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.ja)
</details>

## 概要

Expand Down Expand Up @@ -84,15 +86,15 @@
実はこのtrainingは株式会社万葉が作ったものが元となっていて、間違えて本家のリポジトリに向かってPRを作るという事件が何回か起きてしまいました。
この悲劇を繰り返さないためにページが自動でリダイレクトされるchrome-extensionをインストールしましょう。

#### 1-1: chrome-extensionをcloneする
#### 0-1: chrome-extensionをcloneする

`git clone git@github.com:Fablic/fablic-chrome-extension.git`

#### 1-2: chrome-extensionをインストールする
#### 0-2: chrome-extensionをインストールする

chrome://extensions/ を開いて右上のDeveloper modeをオンにして、RKGithubSupportToolをドラッグ&ドロップでインストールしましょう。

#### 1-3: 株式会社万葉に感謝しつつトレーニングを始める
#### 0-3: 株式会社万葉に感謝しつつトレーニングを始める

[本家のリポジトリ](https://github.com/everyleaf/el-training)

Expand All @@ -109,42 +111,12 @@ chrome://extensions/ を開いて右上のDeveloper modeをオンにして、RKG
- 最新バージョンのRailsをインストールしてください
- `rails -v` コマンドでRailsのバージョンが表示されることを確認してください

#### 1-3: データベース（MySQL）のインストール
Copy link
Author

@kisshy0601 kisshy0601 Apr 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

別の環境構築手順でインストール済みなので。


- 手元のOSでMySQLをインストールしましょう
- macOSの場合は `brew` などでインストールしてください

### ステップ2: GitHubにリポジトリを作成しよう
Copy link
Author

@kisshy0601 kisshy0601 Apr 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

リポジトリは既に存在するので。


- 手元にGitをインストールしましょう
- macOSの場合は `brew` などでインストールしてください
- `gitconfig` でユーザ名、メールアドレスを登録しましょう
- アプリ名を考えましょう
- ブランチを作成しましょう
- masterブランチを元に自分のアカウント名と同じ名前で作成してください
- `git checkout -b github_account_name origin/master`
- 作成したらpushしましょう

### ステップ3: Railsプロジェクトを作成しよう

- `rails new` コマンドでアプリケーションに最低限必要なディレクトリやファイルを作成しましょう
- `rails new` してできたプロジェクトのディレクトリ（アプリ名のディレクトリ）の直下に `docs` というディレクトリを作り、この文書ファイルをコミットしましょう
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

必要があれば作ってもらう程度で、必須要件とはしないため。

- このアプリの仕様を管理下に置き、いつでも見られるようにするためです
- 作成したアプリをGitHub上に作成したブランチにpushしましょう
- バージョンを明示するため、利用するRubyのバージョンを `Gemfile` に記載しましょう（Railsは既にバージョンが記載されていることを確認しましょう）

### ステップ4: 作りたいアプリケーションのイメージを考える
Copy link
Author

@kisshy0601 kisshy0601 Apr 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

技術習得にスーパーフォーカスしているので。要件定義に必要があれば作ってもらいます。

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ステップ4: 受講者のレベルが分かっている場合は不要と思いますが、想像とのギャップが結構ここで分かるので場合によっては入れたいです。

メンターと相談してこのステップが必要な場合スキップしてください
程度にして頂きたいです。


- 設計を進める前に、どのようなアプリになるか完成イメージを（メンターと一緒に）考えてみましょう。ペーパープロトタイピングによる画面設計などがおすすめです
- システムの要件を読んで、必要なデータ構造を考えてみましょう
- どのようなモデル（テーブル）が必要そうか
- テーブル内にどのような情報が必要そうか
- データ構造を考えたら、それをモデル図に手書きで書いてみましょう
- 完成したら撮影して、リポジトリに入れましょう
- `README.md` にテーブルスキーマを記載しましょう（モデル名・カラム名・データ型）

※ 現時点で正解のモデル図を作成する必要はまだありません。現時点での想定として作ってみましょう（今後のステップで間違いと思ったら改修していくイメージです）

### ステップ5: データベースの接続設定（周辺設定）をしましょう

- まずGitで新たにトピックブランチを切りましょう
Expand All @@ -155,7 +127,8 @@ chrome://extensions/ を開いて右上のDeveloper modeをオンにして、RKG
- `rails db:create` コマンドでデータベースの作成をしましょう
- `rails db` コマンドでデータベースへの接続確認をしましょう
- GitHub上でPRを作成してレビューしてもらいましょう
- コメントがついたらその対応を行ってください。LGTM（Looks Good To Me）が2つついたらmasterブランチにマージしましょう
- コメントがついたらその対応を行ってください。
- LGTM（Looks Good To Me）がついたら `keiji-yoshikawa` ブランチにマージしましょう

### ステップ6: タスクモデルを作成しましょう

Expand All @@ -179,31 +152,15 @@ chrome://extensions/ を開いて右上のDeveloper modeをオンにして、RKG
- GitHub上でPRを作成してレビューしてもらいましょう
- 今後、PRが大きくなりそうだったらPRを2回以上に分けることを検討しましょう

### ステップ8: テスト（feature spec）を書こう
Copy link
Author

@kisshy0601 kisshy0601 Apr 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FeatureSpecを業務で利用してないので。

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

はい。スキップでいいと思います。

### ステップ8: テストを書こう

- specを書くための準備をしましょう
- `spec/spec_helper.rb` 、 `spec/rails_helper.rb` を用意しましょう
- feature specをタスク機能に対して書きましょう
- Circle CIなどのCIツールを導入して、Slackに通知するようにしましょう
- オプションですが、メンターが利便性のために追加しても可です
- 参考書籍：https://leanpub.com/everydayrailsrspec-jp
- Model/Controller specをタスク機能に対して書きましょう

### ステップ9: アプリの各種設定を行いましょう
Copy link
Author

@kisshy0601 kisshy0601 Apr 4, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i18nはそのままの形で利用していないので & カスタマイズしたエラーページの実装が必要ないため。

### ステップ9: アプリのタイムゾーン設定を行いましょう

- 日本語部分を共通化
- Railsのi18nの仕組みを利用して、日本語リソースの共通化をしましょう
- ※i18n化を行うと後のステップでメッセージを出したりするのが楽になるなどのメリットがあります
- タイムゾーンの設定
- Railsのタイムゾーンを日本（東京）に設定しましょう
- エラーページの設定
- Railsが用意しているデフォルトのエラーページを自分が作った画面にしてみましょう
- 状況に応じて、適切にエラーページを設定しましょう
- ステータスコードの404ページと500ページの2種類の設定は少なくとも必須とします

### ステップ10: タスク一覧を作成日時の順番で並び替えましょう ★ スキップ可能
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

以下、Model/Controllerの基本的な技術習得（確認）要件はここまでで満たしているため。

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

はい。いいと思います。


- 現在IDの順で並んでいますが、これを作成日時の降順で並び替えてみましょう
- 並び替えがうまく行っていることをfeature specで書いてみましょう
- Railsのタイムゾーンを日本（東京）に設定しましょう

### ステップ11: バリデーションを設定してみよう

Expand All @@ -213,43 +170,24 @@ chrome://extensions/ を開いて右上のDeveloper modeをオンにして、RKG
- マイグレーションファイルだけを作成するため、 `rails generate` コマンドで作成します
- 画面にバリデーションエラーのメッセージを表示するようにしましょう
- バリデーションに対してモデルのテストを書いてみましょう
- GitHub上でPRを作成してレビューしてもらいましょう

### ステップ12: 終了期限を追加しよう ★ スキップ可能

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

　スキップ。いいと思います。

- タスクに対して、終了期限を登録できるようにしてみましょう
- 一覧画面で、終了期限でソートできるようにしましょう
- specを拡充しましょう
- PRしてレビューをしてもらったら、リリースしてみましょう

### ステップ13: ステータスを追加して、検索できるようにしよう

- ステータス（未着手・着手中・完了）を追加してみよう
- 【オプション要件】初学者ではない場合はstateを管理するGemを導入しても構いません
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

削除いいと思います。

- 一覧画面でタイトルとステータスで検索ができるようにしよう
- 【オプション要件】初学者ではない場合はransackなどの検索の実装を便利にするGemを導入しても構いません
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

削除いいと思います。

- 絞り込んだ際、ログを見て発行されるSQLの変化を確認してみましょう
- 以降のステップでも必要に応じて確認する癖をつけましょう
- 検索インデックスを貼りましょう
- 検索に対してmodel specを追加してみよう（feature specも拡充しておきましょう）

### ステップ14: ページネーションを追加しよう
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

スキップいいと思います。


- KaminariというGemを使って一覧画面にページネーションを追加してみましょう

### ステップ15: デザインを当てよう ★ スキップ可能
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

スキップいいと思います。


- Bootstrapを導入して、これまで作成したアプリにデザインを当てましょう
- 【オプション要件】自分でCSSを書いてデザインする

### ステップ16: 複数人で利用できるようにしよう（ユーザの導入）

- ユーザモデルを作成してみましょう
- 最初のユーザをseedで作成してみましょう
- ユーザとタスクが紐づくようにしましょう
- 関連に対してインデックスを貼りましょう
- N+1問題を回避するための仕組みを取り入れましょう

### ステップ17: ログイン/ログアウト機能を実装しよう

- 追加のGemを使わず、自分で実装してみましょう
Expand All @@ -260,124 +198,7 @@ chrome://extensions/ を開いて右上のDeveloper modeをオンにして、RKG
- 自分が作成したタスクだけを表示するようにしましょう
- ログアウト機能を実装しましょう

### ステップ18: ユーザの管理画面を実装しよう ★ スキップ可能

- 画面上に管理メニューを追加しましょう
- 管理画面にはかならず `/admin` というURLを先頭につけるようにしましょう
- `routes.rb` に追加する前に、あらかじめURLやルーティング名（ `*_path` となる名前）を想定して設計してみましょう
- ユーザ一覧・作成・更新・削除を実装しましょう
- ユーザを削除したら、そのユーザが抱えているタスクを削除するようにしてみましょう
- ユーザの一覧画面で、ユーザが持っているタスクの数を表示するようにしてみましょう
- ユーザが作成したタスクの一覧が見られるようにしてみましょう

### ステップ19: ユーザにロールを追加しよう ★ スキップ可能

- ユーザに管理ユーザと一般ユーザを区別するようにしてみましょう
- 管理ユーザだけがユーザ管理画面にアクセスできるようにしてみましょう
- ユーザ管理画面でロールを選択できるようにしましょう
- 管理ユーザが1人もいなくならないように削除の制御をしましょう
- ※ Gemの使用・不使用は自由です

### ステップ20: タスクにラベルをつけられるようにしよう

- タスクに複数のラベルをつけられるようにしてみましょう
- つけたラベルで検索できるようにしてみましょう

### ステップ21: メンテナンス機能を作ろう

- メンテナンスを開始／終了するバッチを作ってみましょう
- メンテナンス中にアクセスしたユーザはメンテナンスページにリダイレクトさせましょう

## あとがき

お疲れさまでした。
あなたは教育カリキュラムを一通り完遂しました!!

せっかく1つのアプリケーションを作り上げたので、是非makitani night(社内LT会)でアプリケーションについて発表してみましょう。
発表の良いきっかけにもなると思います。

このカリキュラムでは触れきれませんでしたが、今後は以下のトピックなどが必要になると思うので、学習を進めていくとよいと思います（案件を通じて学ぶことも多いと思います）。

- Webアプリケーションの基本的な理解を深める
- HTTPとHTTPSに関する理解
- Railsのもう少し進んだ使い方を習得する
- ロギング
- 明示的なトランザクション
- 非同期処理
- アセットパイプライン（どちらかというとリリース系のトピック）
- JavaScriptやCSSなどのフロントエンドに関するより高度な理解
- データベースに対する理解を深める
- SQL
- よりパフォーマンスを重視したクエリの構築
- インデックスの理解をより深める
- サーバ環境に関するより多くの理解
- Linux OS
- Webサーバ（Nginx）の設定
- アプリケーションサーバ（Unicorn）の設定
- MySQLに関する設定への理解
- リリースに関するツールの理解
- Capistrano
- Ansible

## （番外編）オプション要件

必須要件とは別に、タスク管理システムに関するオプション要件を以下に示します。
メンターと相談しつつ必要に応じて実施してみてください。

### オプション要件1: 終了間近や期限の過ぎたタスクがあった場合、アラートを出したい

- ログインした時点で、どこかに終了間近や期限の過ぎたタスクを表示してみましょう
- 既読などが分かるようになるとよりよい

### オプション要件2: ユーザの間でタスクを共有できるようにしたい

- 複数人で同じタスクを参照・編集できるようにしたい
- 例：メンターとメンティーでタスクを共有できること
- 作成者を表示する

### オプション要件3: グループを設定できるようにしたい

- オプション要件2の続き
- グループを設定できるようにして、グループ内だけでタスクを参照できるようにしたい

### オプション要件4: タスクに添付ファイルをつけられるようにしたい

- タスクに対して添付ファイルをつけられるようにしてみましょう
- Herokuの場合はS3バケットにアップロードした添付ファイルを管理するようにします
- 適切にGemを選別して利用してみましょう

### オプション要件5: ユーザにプロフィール画像を設定できるようにしてみましょう

- ユーザがプロフィール画像を設定できるようにしましょう
- アップロードした画像はアイコンとして使用するので、遅くならないようにサムネイル画像も作りたい
- 適切にGemやライブラリを選別しましょう

### オプション要件6: タスクカレンダーの機能がほしい

- 終了期限を可視化するために、カレンダーに終了期限別にタスクを表示するようにしてみましょう
- ライブラリの使用・不使用は自由です

### オプション要件7: タスクをドラッグ&ドロップで並べ替えられるようにしたい

- タスク一覧でタスクをドラッグ&ドロップして並べ替えできるようにしてみましょう

### オプション要件8: ラベルの使用頻度をグラフ化してみましょう

- 統計情報を可視化するために、グラフを導入してみましょう
- グラフの種類は見やすいものを提案してみましょう

### オプション要件9: 終了間近のタスクを作成ユーザ宛てにメール通知してみましょう

- 終了間近のタスクがある場合、バックグラウンドでメール通知してみましょう
- メール送信はクラウドサービスを利用します
- HerokuならばSendGrid
- AWSならばAmazon SESなど
- 1日1回のバッチで送信するようにしてみましょう
- HerokuならばHeroku Scheduler（アドオン）
- AWSだったらcronを設定してみる

### オプション要件10: AWS にインスタンスを作って環境構築する

- AWSに環境構築をしてデプロイしてみましょう
- ミドルウェアはNginx+Unicornを推奨構成とします
- EC2のインスタンス等はサーバ要件を参照してください