Local Development Setup

This document describes how to set up a local development environment.

Please install the following tools on your local machine:

Node.js LTS

Install Node.js 18 lts or later. You can use nvm to install and manage multiple versions of Node.js.

• Windows

  • NVM (Node Version Manager) https://github.com/coreybutler/nvm-windows

• Linux, MacOS, Windows Subsystem for Linux (WSL)

  • NVM (Node Version Manager) https://github.com/nvm-sh/nvm

After installing NVM, run the following command to install Node.js 18 lts:

nvm install 18
nvm use 18

PNPM

Install pnpm using the following command:

npm install -g pnpm

Git

We use Git for version control. Please refer to Gitlab's documentation for how to install Git.

https://docs.gitlab.com/ee/topics/git/how_to_install_git/

Code Editor

Recommended code editor is Visual Studio Code.

• Visual Studio Code https://code.visualstudio.com/

Docker

Install Docker Desktop. https://docs.docker.com/engine/install/#desktop