README.md

Evidently UI

We have two UI projects:

• service - monitoring UI
• standalone - additional package we use for embedding graphics for instance in jupyter notebook and other places

Requirements

• node.js (v20 or higher)
• we also use pnpm (v9) as package manager

Install dependencies

pnpm install

Code quality

We use biome to lint, format and sort imports

vscode

We recommend to use biome vscode plugin.

.vscode/settings.json is following:

{
  "editor.defaultFormatter": "biomejs.biome",
  "[javascript]": {
    "editor.defaultFormatter": "biomejs.biome"
  },
  "editor.formatOnSave": true,
  "biome.lspBin": "./ui/node_modules/@biomejs/biome/bin/biome",
  "biome.searchInPath": false,
  "editor.codeActionsOnSave":{
    "source.organizeImports.biome": "explicit"
  }
}

I like to use the terminal. Just show me the cli

# in `ui` folder
pnpm code-check          # just check: format, sort imports and lint
pnpm code-check --fix  # check and apply appropriate diff (where possible)

Run Service

For now you have to have evidently ui (as a backend) running on localhost:8000

# inside service folder
pnpm dev

Build Service

# inside service folder
pnpm build