ProjectMirador / mirador

An open-source, web-based 'multi-up' viewer that supports zoom-pan-rotate functionality, ability to display/compare simple images, and images with annotations.
https://projectmirador.org
Apache License 2.0
552 stars 256 forks source link

Assistance request install mirador-textoverlay #3769

Open MaximilianoR opened 1 year ago

MaximilianoR commented 1 year ago

I am trying to implement the "mirador-textoverlay" module on my Digital Theca but I am encountering some problems which I will describe.

As described in the "https://github.com/dbmdz/mirador-textoverlay" page I tried to download everything I need using the "npm install mirador-textoverlay" command (to make sure there were no compatibility problems with other programs I created a completely empty Debian 11 VM), but it gives me compatibility errors which I report in Appendix A at the bottom of this post of mine that I tried to fix with negative results I forced the compilation of the material described in the previous point and tried to make a test HTML page with your documentation, when I tried to launch the javascript with the command "import Mirador from 'mirador/dist/es/src/index';" first it wants the script to be of type="module" and it reports me that the index file does not exist and actually only an index file exists in the indicated folder. js file, even if I create a symlink for that file the problem occurs for other internal calls in the code, so I don't understand where I'm going wrong, in appendix B I give you the script as I'm trying to implement it If it helps I am trying to run this on a debian 11 server with apache2

Any help you can give me is welcome and I thank you for your patience

Best regards Massimiliano Randazzo

Appendix A

root@mirador:/usr/local/bin/mirador# npm install mirador-textoverlay npm ERR! code ERESOLVE npm ERR! ERESOLVE unable to resolve dependency tree npm ERR! npm ERR! While resolving: undefined@undefined npm ERR! Found: react@17.0.2 npm ERR! node_modules/react npm ERR! peer react@"^16.8.0 || ^17.0.0" from @material-ui/core@4.12.4 npm ERR! node_modules/@material-ui/core npm ERR! peer @material-ui/core@"^4.11.0" from mirador-textoverlay@0.3.8 npm ERR! node_modules/mirador-textoverlay npm ERR! mirador-textoverlay@"^0.3.8" from the root project npm ERR! peer @material-ui/core@"^4.0.0" from @material-ui/icons@4.11.3 npm ERR! node_modules/@material-ui/icons npm ERR! peer @material-ui/icons@"^4.9.1" from mirador-textoverlay@0.3.8 npm ERR! node_modules/mirador-textoverlay npm ERR! mirador-textoverlay@"^0.3.8" from the root project npm ERR! 1 more (mirador) npm ERR! 2 more (@material-ui/lab, mirador) npm ERR! peer react@"17.0.2" from react-dom@17.0.2 npm ERR! node_modules/react-dom npm ERR! peer react-dom@"^16.8.0 || ^17.0.0" from @material-ui/core@4.12.4 npm ERR! node_modules/@material-ui/core npm ERR! peer @material-ui/core@"^4.11.0" from mirador-textoverlay@0.3.8 npm ERR! node_modules/mirador-textoverlay npm ERR! mirador-textoverlay@"^0.3.8" from the root project npm ERR! 3 more (@material-ui/icons, @material-ui/lab, mirador) npm ERR! peer react-dom@"^16.8.0 || ^17.0.0" from @material-ui/icons@4.11.3 npm ERR! node_modules/@material-ui/icons npm ERR! peer @material-ui/icons@"^4.9.1" from mirador-textoverlay@0.3.8 npm ERR! node_modules/mirador-textoverlay npm ERR! mirador-textoverlay@"^0.3.8" from the root project npm ERR! 1 more (mirador) npm ERR! 1 more (@material-ui/lab) npm ERR! 2 more (@material-ui/icons, @material-ui/lab) npm ERR! npm ERR! Could not resolve dependency: npm ERR! peer react@"^16.8.3" from mirador@3.3.0 npm ERR! node_modules/mirador npm ERR! peer mirador@"^3.0.0" from mirador-textoverlay@0.3.8 npm ERR! node_modules/mirador-textoverlay npm ERR! mirador-textoverlay@"^0.3.8" from the root project npm ERR! npm ERR! Fix the upstream dependency conflict, or retry npm ERR! this command with --force, or --legacy-peer-deps npm ERR! to accept an incorrect (and potentially broken) dependency resolution. npm ERR! npm ERR! See /root/.npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in: npm ERR! /root/.npm/_logs/2023-05-15T06_47_35_049Z-debug.log

Appendix B

jbaiter commented 1 year ago

Please use the latest stable version of Mirador (https://github.com/ProjectMirador/mirador/releases/tag/v3.3.0), the current main branch uses React 17, which is not compatible with the plugin at the moment When a new stable version of Mirador is published, I'll update the plugin accordingly, until then, please use the stable version of Mirador with the plugin.

MaximilianoR commented 1 year ago

by not indicating versions during the installation procedures I expect to use the latest official version.

That said when do you plan to release the official version compatible with this module and its directions for use

Thank you Massimiliano Randazzo

jbaiter commented 1 year ago

Well, the latest "official" version is usually the latest release, i.e. the current "stable" version. The master/main branch of a repository is generally agreed to be the latest "bleeding edge" version, with everything that entails.

I will release an updated version of the plugin when the stable version of Mirador 3 with both the React and MUI upgrades has been released. If there's a stable version before the MUI upgrade has been released, I'll probably make an intermediate release as well.