mirador

️ Este proyecto es para Mirador 3, la última versión de Mirador. Para Mirador 2, consulte ProjectMirador/mirador2 o la documentación heredada en la wiki de Mirador 2. Tenga en cuenta que el enfoque de la comunidad está en Mirador 3 y es poco probable que acepte solicitudes de extracción o brinde soporte para Mirador 2.

mirador

Para usuarios de Mirador

Puedes usar y configurar Mirador rápidamente remezclando el Glitch de inicio de mirador.

Recomendamos instalar Mirador utilizando un administrador de paquetes JavaScript como npm o Yarn.

$ npm install mirador 

# or

$ yarn add mirador

Si está interesado en integrar Mirador con complementos en su proyecto, le recomendamos utilizar webpack o paquete para integrar la versión es de los paquetes. Los ejemplos están aquí:

https://github.com/ProjectMirador/mirador-integration

Si desea simplemente incrustar Mirador en una página HTML sin mayor personalización, incluya la compilación Mirador UMD:

 <script src="https://unpkg.com/mirador@latest/dist/mirador.min.js"></script>

Se pueden encontrar más ejemplos de integración de Mirador en https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript.

Agregar traducciones a Mirador

Para obtener ayuda para agregar una traducción, consulte src/locales/README.md

Ejecutar Mirador localmente para el desarrollo

El desarrollo local de Mirador requiere la instalación de nodejs.

1. Ejecute npm install para instalar las dependencias.

Iniciando el proyecto

$ npm start

Luego navega a http://127.0.0.1:4444/

Creación de instancias de Mirador

 var miradorInstance = Mirador . viewer ( {
  id : 'mirador' // id selector where Mirador should be instantiated
} ) ;

> miradorInstance
{ actions , store }

Acción de ejemplo

Agregar una ventana:

 store . dispatch ( actions . addWindow ( ) ) ;

Para enfocar una ventana, ejecute:

 store . dispatch ( actions . focusWindow ( 'window-1' ) )

Verificar el estado actual

 store . getState ( ) 

ejecutando las pruebas

$ npm test # For headless CI=true npm test

o para ver continuamente los archivos fuente

$ npm run test:watch

Linting el proyecto

$ npm run lint

Depuración

Instancia local

Las siguientes extensiones de navegador son útiles para depurar una instancia de desarrollo local de Mirador:

• Reaccionar herramientas de desarrollo
• Herramientas de desarrollo de Redux

Conjunto de pruebas

Para depurar el conjunto de pruebas, ejecute:

$ npm run test:debug

luego active un cliente inspector de nodejs y establezca algunos puntos de interrupción. Consulte aquí para obtener una guía para depurar con Chrome DevTools.