Skip to main content
Version: Current (3.x)

Getting Started - Frontend

Prerequisites​

  • Node.js version 22 or above (which can be checked by running node -v). You can use nvm or nvm-windows for managing multiple Node versions on a single machine installed. When installing Node.js, you are recommended to check all checkboxes related to dependencies.

Setup​

The following steps will guide you through setting up the project on your local machine.

Setting up the data-viz-ui submodule​

  1. Clone the data-viz-ui repository and add it as a submodule to the project.
git submodule add git@github.com:devgateway/data-viz-ui.git data-viz-ui
  • This will add the data-viz-ui folder to the project as a submodule.
  1. Cd into the data-viz-ui folder.
cd data-viz-ui
  1. Update the data-viz-ui submodules
git submodule update --init --recursive
  1. Run the following command to install the dependencies:
npm install

Setting up the front project​

  1. Cd into the project directory that is found in the front folder.
cd front
  1. Run the following command to install the dependencies:
npm install
  1. Run the following command to start the development server:
npm run dev