Creating a Development Environment

Preparing Tools

Note

The below documentation details our development environment at WESEEK Inc. It may include some tools that are not necessary for your use case.

Install an execution environment for docker and docker-compose

1. Install Ubuntu on WSL2

   > wsl --install
   

   • Confirmation

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

2. Install Docker Desktop (opens new window)

1. Install Docker Desktop (opens new window)
   1. Increase the RAM because of 2 GB runtime memory is set by default.
      • Reference: Change preferences on Mac | Docker Documentation (opens new window)

1. Install Docker Engine on Ubuntu (opens new window)

Install Git

on the host PC:

1. Install Git for Windows (opens new window)
   • Basically, the default settings are fine, but if you have never used Vim or are not familiar with it, change the following options.
     1. Chooseing the default editor used by Git
        • Change to another familiar editor

brew install git

apt-get install git

Configuration

Devcontainer will automatically inherit settings from Docker.
These settings must be set up on the host side.

1. In a WSL2 terminal on the docker host machine, execute the following commands

   # name, email settings
   git config --global user.name "Your Name"
   git config --global user.email "yourname@example.com"
   # If you are using Windows, you will also need to set up a credential helper for WSL to reference the local machines settings
   git config --global credential.helper "/mnt/c/Program\ Files/Git/mingw64/bin/git-credential-manager.exe"
   

1. Open a terminal and execute the following commands

   # name, email settings
   git config --global user.name "Your Name"
   git config --global user.email "yourname@example.com"
   

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

Set up Visual Studio Code

1. Install Visual Studio Code (opens new window)
2. Install extensions
   • Remote - Development
   • Docker

Preparing a Workspace

Note

The below documentation details our development environment at WESEEK Inc. It may include some tools that are not necessary for your use case.

In order to develop using devcontainer, you need to set up a directory tree as follows:

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

• If you are using Windows, use WSL to execute the following commands; on Mac use the included terminal

WARNING

Check before starting git config -l --global should show autoCRLF set to 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