Creating a Development Environment

WARNING

This page is written for GROWI v5.x or below.
For developping GROWI v6.x or above, read the latest startup documents.

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

    Git Setup

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

      Set up Visual Studio Code

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

      GUI Client for MongoDB

      1. Install Robo 3T (opens new window)

      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