開発のすゝめ

branch 命名規則

『Issue 番号-prefix-やる事 (単語は ”_” 区切り)』 例：Issue「#1 Rubocop を入れる」なら「1-add-rubocop_install」

prefix の定義

• add: 新規追加
• fix: 修正（バグ含む）
• refactor: 挙動の変更がない修正
• remove: 単に消すだけ
• test: テスト

参考記事

• qiita 記事

commit message

『[#Issue 番号] prefix: 変更内容』 変更内容には可読性を上げるため日本語を用いる

prefix の定義

branch 命名規則と同じ

例：

[#1000] add: ユーザモデルを追加
(空行)
ユーザモデルの属性は◯◯、▲▲

参考記事

• git commit メッセージ

• CUI で複数行書く方法

test

• 標準の ministest を使う
• 可読性を上げるため日本語を用いる

Sample App

メインの Rails アプリケーション

環境構築

docker-compose build
docker-compose run --rm app bin/setup

サーバー起動

docker-compose up
open http://localhost:3000

テストの実行

docker-compose run --rm app bin/rails test

Rubocop の実行

# 普通に実行
docker-compose run --rm app bundle exec rubocop

# 修正も適用
docker-compose run --rm app bundle exec rubocop -a

# 破壊的な変更も適用（非推奨）
docker-compose run --rm app bundle exec rubocop -A

データのインポート

前準備

1. DB のコンテナを立ち上げる

   docker compose up
   

2. マスタデータがlib/tasks/data/配下にあるか確認する

   lib/tasks
   ├── data
   │   ├── branch_master.csv
   │   ├── cities_master.csv
   │   ├── prefectures_master.csv
   │   ├── property_types_master.csv
   │   └── reviews_master.csv
   └── import.rake
   

インポート

• 都道府県・市区町村

  rails import:address
  

• 店舗

  rails import:branches
  

• 物件種別

  rails import:property_types
  

  物件種別は口コミをインポートする際に同時に作成されるので必須ではない

• 口コミ

  rails import:reviews
  

環境を指定する場合はRAILS_ENV=testのようにオプションをつける

削除

rails db:migrate:reset

サーバへのデプロイ

0. (初回のみ) aws ecs run-task --cluster internship-aug2022-1 --task-definition internship-aug2022-1-db-create --launch-type FARGATE --network-configuration '{"awsvpcConfiguration":{"subnets":["subnet-0334f01a7f2e84910","subnet-06e60f8f517606654","subnet-0df45f1bdece2446d"],"securityGroups": ["sg-04d49093688ad6e41"],"assignPublicIp":"ENABLED"}}' --count 1 で rails db:create を本番環境の DB に適用し、この Rails アプリが使用する MySQL のデータベースを作成する。
1. GitHub Actions タブの deploy ワークフロー に移動
2. This workflow has a workflow_dispatch event trigger. の右側にある Run Workflow ボタンをクリック
3. Use workflow from のセレクトボックスからデプロイ対象のブランチを選択
4. Run Workflow ボタンをクリック

ステージング

https://aug2022-1.intern.speee.in