Continuous Compliance UI project

Project Setup

Install and use NVM: https://github.com/nvm-sh/nvm

nvm install 20 && nvm use 20
npm install

Configuration

Locally

To configure the running frontend, add a file called public/config.json with your configuration.

This file will also be used when running in Docker.

{
  "API_URL": "http://localhost:9000",
  "LOGIN_BANNER": "",
  "LOGIN_BANNER_SEVERITY": "info"
}

LOGIN_BANNER displays a dismissible notice on the login page when set to a non-empty string. LOGIN_BANNER_SEVERITY controls its styling and can be info, warn, error, or success.

Developers can override these values at build time with VITE_LOGIN_BANNER and VITE_LOGIN_BANNER_SEVERITY. VITE_LOGIN_BANNER takes precedence over config.json; setting it to an explicit empty string disables the banner for that build without editing config.json.

In Production

Mount a file called /app/config.json with your configuration.

Compile and Hot-Reload for Development

# Using Docker
docker-compose up -d

# Running locally
npm run dev

Type-Check, Compile and Minify for Production

npm run build

Run Unit Tests with Vitest

npm run test:unit

Lint with ESLint

npm run lint