This repository contains the reference UI for ChRIS, allowing users to create and interact with dynamic containerized workflows. The ChRIS UI is written primarily in TypeScript and React, and uses the PatternFly React pattern library.
Try it now! --> https://app.chrisproject.org
git clone https://github.com/FNNDSC/ChRIS_ui.git
cd ChRIS_ui
npm ci
npm run dev:public
We support development on Linux only.
For local development, use Docker Compose and miniChRIS-docker. Open a terminal and run
git clone https://github.com/FNNDSC/miniChRIS-docker.git
cd miniChRIS-docker
./minichris.sh
If your backend is accessible from a host other than localhost, e.g. you are using a cloud or remote development
server, run cp .env .env.development.local
then edit .env.development.local
with your backend API URL.
You need Node version 20 or 21.
git clone https://github.com/FNNDSC/ChRIS_ui.git
cd ChRIS_ui
npm i
If you are running and have configured a backend in step 0, run
npm run dev
Otherwise, you can use our public testing backend instance. Run
npm run dev:public
Source-to-image must be used to build this project for deployment.
s2i build https://github.com/FNNDSC/ChRIS_ui quay.io/fedora/nodejs-20 s2ichrisui
Ackee can be used for website analytics.
Set the environment variables VITE_ACKEE_SERVER
and VITE_ACKEE_DOMAIN_ID
to send analytics to an Ackee instance.
_ChRISui does unit tests using vitest and end-to-end (E2E) tests using Playwright.
Unit tests are defined in *.test.ts
files inside src
.
It is recommended to leave this command running while developing _ChRISui.
npm test
[!IMPORTANT] End-to-end (E2E) tests are configured to run against our public testing backend instance, which is prepopulated with data.
E2E tests are located under tests/
.
Playwright requires some system dependencies. On first run, you will be prompted to install these dependencies. With Playwright installed, run
npm run test:e2e
For more information, consult the wiki: https://github.com/FNNDSC/ChRIS_ui/wiki/E2E-Testing-with-Playwright