開発環境の構築

WARNING

このページは GROWI v5.x 以下のバージョン向けに書かれています。
GROWI v6.x 以上を開発する場合は、最新の開発スタートアップを確認してください。

各種ツールの準備

Note

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

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

ホストPCで作業します。

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

   > wsl --install
   

   • 確認

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

   1. ホストのメモリを消費しすぎてしまう問題(microsoft/WSL#4166 (opens new window))への対処として、メモリサイズを制限する

      • C:\Users\YourAccount\.wslconfig を編集(ファイルが存在しない場合は作成)

      [wsl2]
      memory=6GB
      swap=0
      

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

1. WSL2 を利用できる状態にする

   1. WSL2 Linux カーネル更新プログラム パッケージ (opens new window) をインストール

   2. 管理者権限で起動した PowerShell で以下を実行

      # Hyper-V の無効化
      Disable-WindowsOptionalFeature -Online -FeatureName $("Microsoft-Hyper-V")
      # WSL の有効化
      Enable-WindowsOptionalFeature -Online -FeatureName $("VirtualMachinePlatform", "Microsoft-Windows-Subsystem-Linux")
      

   3. Microsoft Store で Ubuntu をインストール

      • アプリ名にバージョンが入っていない「Ubuntu」アプリを推奨

        • その時点の最新版(Ubuntu 20.04 LTS 等)へのエイリアスになっている

      • 単体で起動してユーザー作成、ログインまで済ませる

      • 確認

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

      • VERSION 1 で動いている場合は、更に wsl --set-version Ubuntu 2 を打ち込んでディストリビューションを更新する

   4. ホストのメモリを消費しすぎてしまう問題(microsoft/WSL#4166 (opens new window))への対処として、メモリサイズを制限する

      • C:\Users\YourAccount\.wslconfig を編集(ファイルが存在しない場合は作成)

      [wsl2]
      memory=6GB
      swap=0
      

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

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

Git のインストール

ホストPCで作業します。

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

brew install git
brew install git-lfs
git lfs install

設定

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/libexec/git-core/git-credential-manager-core.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 のインストール

MongoDB のための GUI クライアント

1. Robo 3T (opens new window) をインストール

ワークスペース準備

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