Skip to content

docs: update running the ui #2249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2024
Merged

docs: update running the ui #2249

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/getting-started/running/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down