Skip to content

Latest commit

 

History

History
38 lines (26 loc) · 1.38 KB

setup.md

File metadata and controls

38 lines (26 loc) · 1.38 KB
Raw

Setup development environment

Install

  1. Install docker 20.10.13+.
  2. Install docker compose 2.2.3+.

Development with VSCode - Remote container (recommended)

  1. Be sure to have the minimum requirements.
  2. Install the extension ms-vscode-remote.remote-containers.
  3. Ctrl+Shift+P and choose Remote-Containers: Open Folder in Container...
  4. Wait container to be built (it takes a while).
  5. Run ./run install:deps to install all dependencies.
  6. Run ./run help to see all commands for this project.

Development without VSCode

  1. Run ./run --dc-dev dc:console to enter the container.
  2. Run ./run install:deps to install all dependencies.
  3. Run ./run help to see all commands for this project.

UID and GID inside the container

You can change the user's UID/GID inside the container, you can export the variables USER_UID and/or USER_GID.

export USER_UID=1000 USER_GID=1000; ./run dev:code

Note: On Linux, VSCode container handles user's UID/GID by itself. Read the description of remoteUser and updateRemoteUserUID on this page.

FAQ

  1. husky pre-commit is not triggered. Solution: Run npm ci.