Skip to content

reanahub/reana-ui

Repository files navigation

REANA-UI

image image image image image

About

REANA-UI is a component of the REANA reusable and reproducible research data analysis platform. REANA-UI provides a web interface to review production and historical workflows.

Features

  • Profile page containing REANA access token
  • List of personal workflows
  • Workflow details page containing logs, files, specification
  • GitLab integration to load your workflow repositories
  • Cluster health status page

Usage

The detailed information on how to install and use REANA can be found in docs.reana.io.

Development

If you would like to develop this reana-ui package locally on your laptop (without compiling new container images of this component), you can proceed as follows.

Install a local REANA instance on your laptop, following REANA developer wiki.

Install Node version 18 and Yarn version 4. If you are on macOS, beware that Yarn v4 may not be available in brew, so use the official upstream installation technique. For example:

mise use -g node@18
open https://yarnpkg.com/getting-started/install

Clone this repository if you haven't already and go into the React package directory:

git clone https://github.com/reanahub/reana-ui.git
cd reana-ui/reana-ui

We can now install dependencies and start the development server:

yarn
export REANA_SERVER_URL=https://localhost:30443
yarn start

You can now visit https://localhost:3000 to see your local development interface and start seeing your code changes live.

Note that if you are using macOS and are having trouble running yarn, you may need to install several dependent packages:

brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman

Available Yarn scripts:

  • start: start a development server with live reload
  • build: build a production-ready bundle in the build folder
  • test: run unit tests
  • lint: run linter
  • prettier: check code formatting with prettier
  • fmt: fix formatting problems with prettier
  • ci: run both linter and format checkers, useful before committing changes

Useful links

About

REANA UI frontend

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 14