Add parameters to plugin details page. about chris_store_ui

[PintoGideon]

Hi @Aaishpra ,

The parameters and other details for a plugin are pulled from the backend through a JS client. You can find the documentation for the client here. The repo for the client is here.

You can take some time to familiarize yourself with this as it would benefit you for future tasks as well. You can go through the current codebase to see how the client is used. You can fetch the resources associated with each plugin using the id. The documentation for the client should show you how to do that. The response would include all the details you would need to create this page. Let me know if I can elaborate or explain myself better.

[mairin]

@Aaishpra Let me know if you are still interested in this ticket after the Outreachy application period, or if we should clear you as assignee.

[Aaishpra]

I have unassigned @mairin

[merilaclau]

Hi @mairin @PintoGideon
I'm an Outreachy applicant. Would love to try this one out =)
Could you assign this ticket to me?
Thanks in advance!

[Aaishpra]

hey, @mairin I would like to try working here.

[mairin]

Sure @Aaishpra - let me know if you have any questions.

[Aaishpra]

@mairin i guess i have to make additions to this page but i couldn't find the right file which contained parameters (checked create-plugins,plugins and plugin files). It would be great if you can point out the right file to make these enhancements.

[PintoGideon]

Hey @Aaishpra , Do you have the react dev tools extension downloaded? This link here should help you get started.

Once you have that installed, just click on inspect element (right click and choose Inspect element) on the desired page in the UI, go to the components tab in the browser and look for the component name in the component tree. . You can then search for the component name in the ChRIS_store_ui's folder and that should point you to the file. The link should explain that better, but if you still have questions, let me know and I can point you to the file or add snapshots explaining this better.

[Aaishpra]

Thanks @PintoGideon it helped the component was Pluginbody.js.
Now working on it will ask more questions if got stuck again

[Aaishpra]

Hey, @PintoGideon @mairin the Are the parameters and other details here supposed to be similar for every plugin (means can be added via simple text) or we have to get these details from somewhere (means the parameters are supposed to be different for every plugin)?
If they are supposed to be different how can i get them?

[Aaishpra]

Hey, @PintoGideon I don't see any parameters associated with plugins on this URL http://localhost:8010/api/v1/ all I see is id, creation date, modification date, name, title, stars repo, and other details of the plugins.
Can you help?

[PintoGideon]

Hey @Aaishpra , Looks like from the js client's documentation, you can get the plugin parameters by doing this.

const parameters = await plugin.getPluginParameters();

The snippet above assumes you have the plugin fetched from the backend on which you want to fetch the parameters.
The idea here is once you have the plugin, you can fetch more resources like the plugin meta and the plugin parameters by making those get function calls (which ideally makes get requests behind the scenes). Let me know if this makes sense. I can definitely try and explain better,

[PintoGideon]

@Aaishpra , Just run through the examples here if you haven't. This usually clears things up. Again, feel free to ask as many questions you want.

Here is the relevant snippet for your needs:

[Aaishpra]

Thanks for this. I will update you soon

[laris678]

Hi @mairin @PintoGideon
I am an outreachy applicant 2022. I will like to do this , can you please assign this ticket to me
awaiting response
thanks