From 8f264b6ed4122b1a879330c32039a435ba3374e1 Mon Sep 17 00:00:00 2001 From: Josh Habdas Date: Thu, 25 Apr 2024 13:50:13 -0400 Subject: [PATCH] docs: update running the ui --- docs/getting-started/running/index.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/getting-started/running/index.md b/docs/getting-started/running/index.md index d10be8bf96..a6de414ea2 100644 --- a/docs/getting-started/running/index.md +++ b/docs/getting-started/running/index.md @@ -32,6 +32,19 @@ You can use any email that the system has in its loaded test data. The "password # Running the UI +The UI will be available on port 8080 once the application is running. The UI is served from the `web-ui` directory. The UI is built using Vite, a modern build tool for frontend development. The UI is written in JavaScript and uses React and Vitest. + +## Node Version + +When developing against the UI, please use the latest Node LTS. A `.nvmrc` file is provided in the `web-ui` directory to help you manage the Node version. You can use the following command to switch to the expected Node version: + +```shell +nvm install --lts +nvm use --lts +``` + +Or `cd` to the `web-ui` directory and run `nvm use` to be prompted to install the expected Node version as configured in the `.nvmrc` file. + ## HMR For hot reloading during UI development, you can use the following command to start a Vite server: