Setup webclient for development

Introduction

Welcome to the webclient project setup guide. In this guide, we will walk you through the steps required to set up the webclient project for development. We will be using Node Version Manager (nvm) to install and manage Node.js versions.

Install nodejs with nvm

1. Install nvm

   curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash

2. Reload the shell

   exec $$SHELL

3. Install Node.js (version 20.5.0)

   nvm install v20.5.0

Clone the repository

Clone the repository with the branch v2 as the default checkout.

Tip

If you already have the repository cloned, you can change the branch using

git checkout -b v2 origin/v2

git clone git@github.com:gisce/webclient.git -b v2

Copy the default environment

cp .env.sample .env

Then we have to install all the dependencies with

npm ci

Next, you can run a script to clone and run all related projects. This will clone, install, link, and run these projects in development mode. You only need to select them if you want to add a new feature to them.

The common projects to select are: react-ooui and ooui.

Related projectes

npm run link

Note

If you only want to use the webclient we only need to clone webclient and follow the instrucions in setup simple