開発環境

必要なもの

• Docker
  • Windows 64bit: Docker CE for Windows
  • Windows 32bit または上記の方法でうまく行かない場合: docker-machineを使用。詳しく見る
  • macOS: Docker CE for macOS
  • GNU/Linux: 適当にディストリを選んで
• Docker Compose
  • ここを読んでインストール
• Git
  • Windows: Git for Windows
  • macOS: brew install git
  • GNU/Linux: ディストリごとに適当に
• gitflow-avh (ただのgitflowではなくAVH Editionを使用してください)
  • Windows: Git for Windowsに同梱
  • macOS: brew install gitflow-avh
  • GNU/Linux: See Here
• Bash 4
  • Windows: 元から入っている(WSL/Git Bash)
  • macOS: brew install bash
  • GNU/Linut: 元から入っていることが多い
• md5sum
  • Windows: 元から入っている(WSL/Git Bash)
  • macOS: brew install md5sha1sum
  • GNU/Linux: 元から入っていることが多い

セットアップ

git clone --recursive https://github.com/Sakuten/devenv
cd devenv
# フロントエンドの開発をする場合
cd frontend
git pull origin develop # 最新のソースに更新
# バックエンドの開発をする場合
cd backend
git pull origin develop # 最新のソースに更新

開発を開始

docker-compose.ymlがあるディレクトリで

./scripts/start.sh

.envに記載されたポートが開くので、開発が開始できます frontend/とbackend/はそれぞれ編集すると自動でリロードがかかりますので、お好みのエディタで編集してください

コマンド群

• ./scripts/start.sh: 開発環境を開始します
• ./scripts/stop.sh: 開発環境を停止します
• ./scripts/build.sh [frontend|backend]: 開発に使うdockerイメージをビルドします
• ./scripts/fix.sh [frontend|backend]: Lintおよびコードの自動フォーマットを行います
• ./scripts/lint.sh [frontend|backend]: Lintをします (自動修正はせず、指摘のみです)
• ./scripts/test.sh: E2Eテストを走らせます
• ./scripts/unit_test.sh [frontend|backend]: frontend, backendそれぞれについてユニットテストを走らせます
• ./scripts/report.sh: IssueやPRを建てる時に使える診断情報を出力します
• ./scripts/cleanup.sh: 環境を再構築します。なんかうまくいかないときにどうぞ

ワークフロー

0. (バグを見つけたり、やらなきゃいけないことを見つけたりしたらIssueを立てます。)
1. あなたががIssueにアサインされます
2. ローカルでfeatureやbugfixブランチを切ります

# 最新のコミットを取得
git pull origin develop

# 機能追加の場合
git flow feature start feature-name # feature-nameは例です。自分で名付けます。

# バグ修正の場合
git flow bugfix start bugfix-name # bugfix-nameは例です。自分で名付けます。

※ブランチ名は慣習的にkebab-caseです

3. 該当機能/修正を実装します

4. 自分の書いた変更について、テストを書きます

5. Lint, Unit Testが通ることを確認してください。またこの段階でE2E Testが通る必要はありません。

6. ブランチをpushしてGitHub上でPull Requestを出します (ここでgit flow feature finishしないでください)

git push origin feature/feature-name # 先ほど作ったブランチをpushする

この際、Pull Request上に元のIssueへのリンクを、元のIssue上にPull Requestへのリンクを、それぞれ記載してください。

7. あなたのPull Requestを@Sakuten/moderator がレビューします。指示があったら従ってください
8. マージされたらIssue解決です、ありがとうございました。

Windows 32bit

64BitでもDocker CEが入らなさそうだったらこっちでお願いします

ちょっと手順が特殊です

1. Chocolateyをインストール
2. VirtualBoxをインストール
3. Git for Windowsをインストール
4. docker-machineをインストール: choco install docker-machine -y
5. Powershellでfsutil behavior set SymlinkEvaluation L2L:1 R2R:1 L2R:1 R2L:1と実行
6. Git Bashで以下を実行し、仮想マシンを作る

docker-machine create --driver virtualbox default

7. Git Bashで以下を実行し、仮想マシンに入る

docker-machine ssh default -L 8000:localhost:8000 -L 8081:localhost:8081 -L 8888:localhost:8888

8. (ここから仮想マシン上で)以下のコマンドを実行し、composeをインストールする

sudo curl -L https://github.com/docker/compose/releases/download/1.21.2/docker-compose-$(uname -s)-$(uname -m) -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

9. devenvのディレクトリへcd
10. docker-compose up
11. 完了。あとはWindows側から更新すれば自動ビルドがかかります

初回以降は7からやればOKです