Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fnndsc/chris_ui
UI for ChRIS
https://github.com/fnndsc/chris_ui
css html5 javascript medical patternfly reactjs spa typescript
Last synced: 4 days ago
JSON representation
UI for ChRIS
- Host: GitHub
- URL: https://github.com/fnndsc/chris_ui
- Owner: FNNDSC
- License: mit
- Created: 2019-01-15T20:23:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-23T20:43:50.000Z (4 months ago)
- Last Synced: 2024-10-24T08:32:34.469Z (4 months ago)
- Topics: css, html5, javascript, medical, patternfly, reactjs, spa, typescript
- Language: TypeScript
- Homepage:
- Size: 42 MB
- Stars: 53
- Watchers: 14
- Forks: 115
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  ChRIS_ui
![License][license-badge]
![Last Commit][last-commit-badge]
![Code Size][code-size]
[](https://codecov.io/gh/FNNDSC/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](https://www.typescriptlang.org/) and [React](https://reactjs.org/), and uses the [PatternFly](https://github.com/patternfly/patternfly) React pattern library.
**Try it now!** --> https://app.chrisproject.org
## Quickstart
```shell
git clone https://github.com/FNNDSC/ChRIS_ui.git
cd ChRIS_ui
npm ci
npm run dev:public
```
## Development
There are two modes of development:
- "local": runs the _ChRIS_ backend locally. Requires Docker, and uses more disk space + slower startup time.
- "public": use the global, public testing server. This is the easier option, especially for non-Linux OS.
Alternatively, start the backend in development mode (click to expand)
##### Get the backend running from ChRIS_ultron_backEnd
```bash
$ 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:
```bash
$ cd ChRIS_ultron_backEnd
$ sudo rm -r FS
$ ./unmake.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.
### 1. Dependencies
You need Node version 20 or 21.
```shell
git clone https://github.com/FNNDSC/ChRIS_ui.git
cd ChRIS_ui
npm ci
```
#### Local Development Dependencies
No extra dependencies are required when using the "public" server.
If you intend on developing with the "local" server, you will need **Docker** and Docker Compose
to run the backend and helper scripts.
### 2. Run the development server
Either using the "public" server:
```shell
npm run dev:public
```
Or, start a local backend and run the "local" server:
```shell
npm run dev:local
```
## Build for production
[Source-to-image](https://github.com/openshift/source-to-image#readme)
must be used to build this project for deployment.
```shell
s2i build https://github.com/FNNDSC/ChRIS_ui quay.io/fedora/nodejs-20 s2ichrisui
```
## Analytics
[Ackee](https://ackee.electerious.com/) 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.
## Testing
_ChRIS_ui_ does unit tests using [vitest](https://vitest.dev/) and end-to-end (E2E) tests using [Playwright](https://playwright.dev).
### Unit Tests
Unit tests are defined in `*.test.ts` files inside `src`.
It is recommended to leave this command running while developing _ChRIS_ui_.
```shell
npm test
```
### End-to-End Tests
End-to-end tests are located under `tests/`.
The end-to-end testing framework, Playwright, requires some system dependencies.
On first run, you will be prompted to install these dependencies.
```shell
npm run test:e2e # run tests using "public" backend
npm run test:e2e:local # run tests using "local" backend
```
For more information, consult the wiki:
https://github.com/FNNDSC/ChRIS_ui/wiki/E2E-Testing-with-Playwright
[license-badge]: https://img.shields.io/github/license/fnndsc/chris_ui.svg
[last-commit-badge]: https://img.shields.io/github/last-commit/fnndsc/chris_ui.svg
[repo-link]: https://github.com/FNNDSC/ChRIS_ui
[code-size]: https://img.shields.io/github/languages/code-size/FNNDSC/ChRIS_ui