{"id":19612059,"url":"https://github.com/fnndsc/chris_ui","last_synced_at":"2025-04-04T10:09:38.540Z","repository":{"id":37270847,"uuid":"165918038","full_name":"FNNDSC/ChRIS_ui","owner":"FNNDSC","description":"UI for ChRIS","archived":false,"fork":false,"pushed_at":"2024-10-23T20:43:50.000Z","size":44071,"stargazers_count":53,"open_issues_count":50,"forks_count":115,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-10-24T08:32:34.469Z","etag":null,"topics":["css","html5","javascript","medical","patternfly","reactjs","spa","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FNNDSC.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-15T20:23:51.000Z","updated_at":"2024-09-23T19:28:59.000Z","dependencies_parsed_at":"2023-12-20T21:22:11.677Z","dependency_job_id":"1cd75a23-8a21-4ad3-9319-6bd623a38e3b","html_url":"https://github.com/FNNDSC/ChRIS_ui","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FNNDSC%2FChRIS_ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FNNDSC%2FChRIS_ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FNNDSC%2FChRIS_ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FNNDSC%2FChRIS_ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FNNDSC","download_url":"https://codeload.github.com/FNNDSC/ChRIS_ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247157283,"owners_count":20893220,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["css","html5","javascript","medical","patternfly","reactjs","spa","typescript"],"created_at":"2024-11-11T10:45:46.076Z","updated_at":"2025-04-04T10:09:38.508Z","avatar_url":"https://github.com/FNNDSC.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ![ChRIS logo](https://github.com/FNNDSC/ChRIS_ultron_backEnd/blob/master/docs/assets/logo_chris.png) ChRIS_ui\n\n![License][license-badge]\n![Last Commit][last-commit-badge]\n![Code Size][code-size]\n[![codecov](https://codecov.io/gh/FNNDSC/ChRIS_ui/graph/badge.svg?token=J9PCSEQ5E5)](https://codecov.io/gh/FNNDSC/ChRIS_ui)\n\nThis 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.\n\n![Screenshot from 2023-12-05 09-22-38](https://github.com/FNNDSC/ChRIS_ui/assets/15992276/a8314bfe-e6e2-4e9c-b1c6-f7fb99e4c882)\n\n**Try it now!** --\u003e https://app.chrisproject.org\n\n## Quickstart\n\n```shell\ngit clone https://github.com/FNNDSC/ChRIS_ui.git\ncd ChRIS_ui\nnpm ci\nnpm run dev:public\n```\n\n## Development\n\nThere are two modes of development:\n\n- \"local\": runs the _ChRIS_ backend locally. Requires Docker, and uses more disk space + slower startup time.\n- \"public\": use the global, public testing server. This is the easier option, especially for non-Linux OS.\n \n\u003cdetails\u003e\n\u003csummary\u003e\n  \u003cstrong\u003e\n    Alternatively, start the backend in development mode (click to expand)\n  \u003c/strong\u003e\n\u003c/summary\u003e\n\n##### Get the backend running from ChRIS_ultron_backEnd\n\n```bash\n$ git clone https://github.com/FNNDSC/ChRIS_ultron_backEnd.git\n$ cd ChRIS_ultron_backEnd\n$ ./make.sh -U -I -i\n```\n\n##### Tearing down the ChRIS backend\n\nYou can later remove all the backend containers and release storage volumes with:\n\n```bash\n$ cd ChRIS_ultron_backEnd\n$ sudo rm -r FS\n$ ./unmake.sh\n```\n\n\u003c/details\u003e\n\nIf your backend is accessible from a host other than localhost, e.g. you are using a cloud or remote development\nserver, run `cp .env .env.development.local` then edit `.env.development.local` with your backend API URL.\n\n### 1. Dependencies\n\nYou need Node version 20 or 21.\n\n```shell\ngit clone https://github.com/FNNDSC/ChRIS_ui.git\ncd ChRIS_ui\nnpm ci\n```\n\n#### Local Development Dependencies\n\nNo extra dependencies are required when using the \"public\" server.\n\nIf you intend on developing with the \"local\" server, you will need **Docker** and Docker Compose\nto run the backend and helper scripts.\n\n### 2. Run the development server\n\nEither using the \"public\" server:\n\n```shell\nnpm run dev:public\n```\n\nOr, start a local backend and run the \"local\" server:\n\n```shell\nnpm run dev:local\n```\n\n## Build for production\n\n[Source-to-image](https://github.com/openshift/source-to-image#readme)\nmust be used to build this project for deployment.\n\n```shell\ns2i build https://github.com/FNNDSC/ChRIS_ui quay.io/fedora/nodejs-20 s2ichrisui\n```\n\n## Analytics\n\n[Ackee](https://ackee.electerious.com/) can be used for website analytics.\nSet the environment variables `VITE_ACKEE_SERVER` and `VITE_ACKEE_DOMAIN_ID`\nto send analytics to an Ackee instance.\n\n## Testing\n\n_ChRIS_ui_ does unit tests using [vitest](https://vitest.dev/) and end-to-end (E2E) tests using [Playwright](https://playwright.dev).\n\n### Unit Tests\n\nUnit tests are defined in `*.test.ts` files inside `src`.\n\nIt is recommended to leave this command running while developing _ChRIS_ui_.\n\n```shell\nnpm test\n```\n\n### End-to-End Tests\n\nEnd-to-end tests are located under `tests/`.\n\nThe end-to-end testing framework, Playwright, requires some system dependencies.\nOn first run, you will be prompted to install these dependencies.\n\n```shell\nnpm run test:e2e  # run tests using \"public\" backend\n\nnpm run test:e2e:local  # run tests using \"local\" backend\n```\n\nFor more information, consult the wiki:\nhttps://github.com/FNNDSC/ChRIS_ui/wiki/E2E-Testing-with-Playwright\n\n\u003c!-- Image Links --\u003e\n\n[license-badge]: https://img.shields.io/github/license/fnndsc/chris_ui.svg\n[last-commit-badge]: https://img.shields.io/github/last-commit/fnndsc/chris_ui.svg\n[repo-link]: https://github.com/FNNDSC/ChRIS_ui\n[code-size]: https://img.shields.io/github/languages/code-size/FNNDSC/ChRIS_ui\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffnndsc%2Fchris_ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffnndsc%2Fchris_ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffnndsc%2Fchris_ui/lists"}