CVE Data Registry Client

The CVE Data Registry Client is a frontend for the CVE Services API (https://github.com/CVEProject/cve-services.)

The app can connect to one or more CVE Services API instances. In static builds, such as GitHub Pages, available login instances are selected at build time with VITE_AVAILABLE_INSTANCES. In Docker, the same list can be supplied at runtime with AVAILABLE_INSTANCES.

Use a comma-separated list of instance keys:

AVAILABLE_INSTANCES=test,prod

Run Locally

Running locally will allow you to log into all instances in app/src/config.js given you have credentials for remote APIs or a local version running.

cd app
npm i
npm run dev

The app runs at http://localhost:5173.

Build for GitHub Pages

git checkout gh-pages-deploy
git rebase dev
cd app
npm run predeploy
git add .
git commit -m "Build GitHub Pages deployment"
git push

Run with Docker

Run the app from the repository root:

docker compose up --build

The app runs at http://localhost:8080.

Limit the available login instances at runtime:

AVAILABLE_INSTANCES=test,prod docker compose up --build

The app can connect to any number of backend service APIs depending on the build command or runtime environment variable. Use a comma-separated list of instance keys.

Check container health:

curl http://localhost:8080/health-check

If you need to build or run the image without Compose:

docker build -t cve-user-registry-client .
docker run --rm -e AVAILABLE_INSTANCES=test,prod -p 8080:8080 cve-user-registry-client