ChRIS_ui

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.

Quickstart

First, get the ChRIS backend running. Assuming the backend is on http://localhost:8000/api/v1/:

docker run --rm -d --name chris_ui -p 3000:3000 -e REACT_APP_CHRIS_UI_URL=http://localhost:8000/api/v1/ ghcr.io/fnndsc/chris_ui:latest

The ChRIS_ui is now running on http://localhost:3000/

Development

[0] Preconditions

1. Install latest Docker for your platform.

   Currently tested platforms

   • Ubuntu 18.04+ (typically 20.04+, and Pop!_OS)
   • Fedora 32+
   • Arch Linux
   • macOS 11.X+ (Big Sur)

2. Get the backend services up so you can fully test the UI against actual data.

   • Install latest Docker Compose
   • On a Linux machine make sure to add your computer user to the docker group

3. Open a terminal and start the backend services.

   git clone https://github.com/FNNDSC/miniChRIS.git
   cd miniChRIS
   ./minichris.sh

   Alternatively, start the backend in development mode:

   Get the backend running from ChRIS_ultron_backEnd

   $ git clone https://github.com/FNNDSC/ChRIS_ultron_backEnd.git
   $ cd ChRIS_ultron_backEnd
   $ ./make.sh -U -I -i

   Tearing down the ChRIS backend

   You can later remove all the backend containers and release storage volumes with:

   $ cd ChRIS_ultron_backEnd
   $ sudo rm -r FS
   $ ./unmake.sh

See FNNDSC/miniChRIS for details.

[1] Configuring the backend URL

For development, it is recommended that you create either a .env.local or .env.development.local environment variables file in the root of the project. Copy the existing .env file to this new file. Changes to these files will be ignored by git.

There are four (4) major environment variables that need to be set.

• Point REACT_APP_CHRIS_UI_URL to your local backend instance. By default (or if you copied the .env file) this is set to http://localhost:8000/api/v1/.

• Point REACT_APP_PFDCM_URL to the URL of a running PFDCM instance. By default this is set to http://localhost:4005/.

• Set REACT_APP_PFDCM_CUBEKEY and REACT_APP_PFDCM_SWIFTKEY to the aliases (or keys) given to CUBE and Swift while setting up PFDCM. By default these are both local. If you're unsure what to use, you can list CUBE and Swift keys using the PFDCM API, or ask for these keys.

For details on how to set up PFDCM, refer to the PFDCM readme.

[2] Start UI development server

You can follow any of these steps to start UI development server

• Using node and yarn package manager directly on the metal

  Open a new terminal on your system and follow these steps:

  $ git clone https://github.com/FNNDSC/ChRIS_ui.git
  $ cd ChRIS_ui
  $ npm i
  $ npm start

  More details can be found in the wiki.

• Using docker

  Open a new terminal on your system and follow these steps:

  $ git clone https://github.com/FNNDSC/ChRIS_ui.git
  $ cd ChRIS_ui
  $ docker build -t fnndsc/chris_ui:dev -f Dockerfile_dev .
  $ docker run --rm -it -v $PWD:/home/localuser -p 3000:3000 -u $(id -u):$(id -g) --userns=host --name chris_ui fnndsc/chris_ui:dev

  Open http://localhost:3000 to view it in the browser.

Build the ChRIS UI app for production

$ cd ChRIS_ui
$ docker build -t local/chris_ui .

It correctly bundles React in production mode and optimizes the build for the best performance. The build is minified and the filenames include the hashes.

Your app is ready to be deployed!

Deploy and serve the ChRIS UI app

$ docker run --name chris_ui -p <desired port>:3000 -d local/chris_ui

Learn More

Interested in contributing? https://chrisproject.org/join-us

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.