ChRIS_ui icon indicating copy to clipboard operation
ChRIS_ui copied to clipboard

Add API methods to ChRIS Store to support displaying metadata from the ChRIS store in the core ChRIS UI for installed plugins

Open mairin opened this issue 3 years ago • 10 comments

The idea for this came from the ChRIS weekly status meeting on 27 Jan 2022.

The ChRIS Store has additional metadata for installed plugins that isn't available in the plugin definition file and so isn't available for display in the core ChRIS UI. For example, the ChRIS store has the README file for the plugin.

It would be very nice to have this additional metadata available to the ChRIS core UI, by having an API exposed in the ChRIS store so that a ChRIS core UI could retrieve the metadata from the ChRIS store.

mairin avatar Feb 03 '22 21:02 mairin

I would like to pickup this issue to contribute to this project as a part of Outreachy'22

reeshipaul avatar Mar 26 '22 13:03 reeshipaul

@mairin can you add more details about the proposed feature?

jennydaman avatar Mar 28 '22 15:03 jennydaman

@mairin please add some details to the issue so that I can start working on this

reeshipaul avatar Apr 02 '22 21:04 reeshipaul

@reeshi-18 the ChRIS Store, https://chrisstore.co, is a repository of ChRIS plugins. Plugins are added from the ChRIS Store to a ChRIS backend.

The ChRIS_ui displays some information about plugins, but perhaps more information can be shown. See in the ChRIS_uii, in the sidebar click "Analysis Catalog" > "Plugins" and click on any plugin card to expand its details. Please propose and implement a feature which can improve this information display.

image

jennydaman avatar Apr 07 '22 07:04 jennydaman

Here is an easy suggestion: add something to the popup panel along the lines of

<a href={`https://chrisstore.co/plugins?q=${pluginName}`}>Search for me in chrisstore.co</a>

jennydaman avatar Apr 07 '22 07:04 jennydaman

do i need to setup chris plugins repo for the same? @jennydaman I already have chris ui and minichris setup in my local

reeshipaul avatar Apr 07 '22 15:04 reeshipaul

Sorry I don't understand, what do you mean by "setup chris plugins repo?"

To work on this issue, running just ChRIS_ui and miniChRIS should be sufficient.

jennydaman avatar Apr 08 '22 17:04 jennydaman

@reeshi-18 would you like to collaborate with me on this ?, I had some ideas as to what else we can put on there , in the drawer card.

qxprakash avatar Apr 22 '22 18:04 qxprakash

Here is an easy suggestion: add something to the popup panel along the lines of

<a href={`https://chrisstore.co/plugins?q=${pluginName}`}>Search for me in chrisstore.co</a>

@jennydaman Nice suggestion, we can add data as a popup or additional card. Can you specify exactly which additional metadata for the installed plugin from the ChRIS store is to be rendered on the ChRIS core UI?

somya51p avatar May 04 '22 14:05 somya51p

@jennydaman if this issue is still open, I'll like to work on it.

Seundede avatar Oct 18 '22 18:10 Seundede