開発環境の構築

各種ツールの準備

Note

以下は GROWI, Inc. で統一している開発環境の紹介です。 そのため、開発にあたって必須ではない設定やツールの指定が含まれています。

docker, docker-compose 実行環境のインストール

ホストPCで作業します。

1. Ubuntu on WSL2 のインストール

   > wsl --install
   

   • 確認

     > wsl -l -v
     NAME      STATE           VERSION
     * Ubuntu    Stopped         2
     

2. Docker Desktop (opens new window) をインストール

1. Docker Desktop (opens new window) をインストール
   1. メモリ利用量上限がデフォルトでは 2GB に設定されているので変更する
      • 参考: Change preferences on Mac | Docker Documentation (opens new window)

1. Docker Engine on Ubuntu をインストール (opens new window)

Git のインストール

ホストPCで作業します。

1. Git for Windows (opens new window) のインストール
   • 基本的に初期設定でよいが、Vim を触ったことがない人、あるいは慣れていない人は以下のオプションを変更する
     1. Chooseing the default editor used by Git
        • 他のエディタに変更する

brew install git

apt-get install git

設定

devcontainer は 自動的に docker ホストの設定を参照します。

ここではコンテナ内部から参照するためのホスト側の設定を行います。

1. docker ホストとなる WSL2 のターミナルで以下を実行する

   # name, email の設定
   git config --global user.name "Your Name"
   git config --global user.email "yourname@example.com"
   # autocrlf 無効化
   git config --global core.autocrlf false
   # Windows の場合は、WSL 内から更にホストPCの credential helper を参照する設定を行う
   git config --global credential.helper "/mnt/c/Program\ Files/Git/mingw64/bin/git-credential-manager.exe"
   

1. ホストPCのターミナルで以下を実行

   # name, email の設定
   git config --global user.name "Your Name"
   git config --global user.email "yourname@example.com"
   # autocrlf 無効化
   git config --global core.autocrlf false
   

2. Git Credential Helper (GCM) を設定する
   https://docs.github.com/en/get-started/getting-started-with-git/caching-your-github-credentials-in-git (opens new window)

Visual Studio Code のセットアップ

1. Visual Studio Code (opens new window) をインストール
2. 拡張機能をインストール
   • 「Remote - Development」extension のインストール

ワークスペース準備

devcontainer で開発するには、以下のような構造のディレクトリツリーが必要です。

- GROWI
    - growi                   <-- weseek/growi repository
    - growi-docker-compose    <-- weseek/growi-docker-compose repository

• 以下の手順を、Windows の場合は WSL 内、Mac の場合はホストPCで作業します

WARNING

事前チェック git config -l --global で、autoCRLF が false になっていることを確認しましょう

mkdir -p ~/Projects/GROWI
cd ~/Projects/GROWI
git clone https://github.com/weseek/growi.git
git clone https://github.com/weseek/growi-docker-compose.git