turath-project / invenio-previewer-mirador

Invenio module that integrates the Mirador viewer as a previewer for digital objects within the InvenioRDM platform.
MIT License
0 stars 0 forks source link

Integrate Mirador Viewer as a Previewer in Invenio #1

Open mkhashoggi opened 1 month ago

mkhashoggi commented 1 month ago

Description:

We need to integrate the Mirador viewer as a previewer within the InvenioRDM platform. The purpose of this integration is to allow users to preview IIIF-compatible digital objects directly within Invenio.

1. Review the Relevant PRs and documentation

First, review the existing pull requests that relate to Mirador in the Invenio organization:

  1. Visit the link you provided: Invenio Mirador PRs.
  2. Identify the PRs relevant to your module. Look at the specific changes, the discussion around them, and any feedback provided by the maintainers.

This step is essential to ensure that you understand the implementation details and any potential issues that might have caused the PRs to remain unmerged.

Review relevant documentation in Invenio repos:

2. Integrate Existing Code from the PRs

Modify the module to fit the new structure:

3. Test the Module

After integrating the code, thoroughly test the module:

  1. Run the provided test suite or create new tests as needed.
  2. Check compatibility with the latest version of InvenioRDM.
  3. Test the Mirador previewer to ensure it behaves as expected.

Acceptance Criteria:

mkhashoggi commented 3 weeks ago

Hey @PrydolobOleksandr , Please make sure this task is completed inside this repo. You can test it later by installing on a local deployment. Once it's working, we can integrate this to the main repo by installing the plug in inside the instance. If you have any doubt or not sure about a thing, please contact me for more info. I want to help you to complete this on the highest possible quality but you need to make sure it's done right by reading the right documentation and it meets our expections.