mirador

️ Ce projet concerne Mirador 3, la dernière version de Mirador. Pour Mirador 2, veuillez consulter ProjectMirador/mirador2 ou la documentation existante sur le wiki Mirador 2. Veuillez noter que la communauté se concentre sur Mirador 3 et qu'il est peu probable qu'elle accepte les pull request ou fournisse un support pour Mirador 2.

Mirador

Pour les utilisateurs de Mirador

Vous pouvez rapidement utiliser et configurer Mirador en remixant le Glitch de démarrage de mirador.

Nous vous recommandons d'installer Mirador à l'aide d'un gestionnaire de packages JavaScript comme npm ou Yarn.

$ npm install mirador 

# or

$ yarn add mirador

Si vous souhaitez intégrer Mirador avec des plugins dans votre projet, nous vous recommandons d'utiliser webpack ou parcel pour intégrer la version es des packages. Des exemples sont ici :

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

Si vous souhaitez simplement intégrer Mirador dans une page HTML sans autre personnalisation, incluez la version Mirador UMD :

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

D'autres exemples d'intégration de Mirador peuvent être trouvés sur https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript.

Ajout de traductions à Mirador

Pour obtenir de l'aide sur l'ajout d'une traduction, voir src/locales/README.md

Exécuter Mirador localement pour le développement

Le développement local de Mirador nécessite l'installation de nodejs.

1. Exécutez npm install pour installer les dépendances.

Démarrage du projet

$ npm start

Accédez ensuite à http://127.0.0.1:4444/

Instanciation de Mirador

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

> miradorInstance
{ actions , store }

Exemple d'action

Ajouter une fenêtre :

 store . dispatch ( actions . addWindow ( ) ) ;

Pour focaliser une exécution de fenêtre :

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

Vérifier l'état actuel

 store . getState ( ) 

Exécuter les tests

$ npm test # For headless CI=true npm test

ou pour regarder continuellement les fichiers sources

$ npm run test:watch

Pelucher le projet

$ npm run lint

Débogage

Instance locale

Les extensions de navigateur suivantes sont utiles pour déboguer une instance de développement local de Mirador :

• Réagir aux outils de développement
• Outils de développement Redux

Suite de tests

Pour déboguer la suite de tests, exécutez :

$ npm run test:debug

puis lancez un client inspecteur nodejs et définissez quelques points d'arrêt. Voir ici pour un guide de débogage avec Chrome DevTools.