mirador

️ Этот проект предназначен для Mirador 3, последней версии Mirador. Для Mirador 2 см. ProjectMirador/mirador2 или устаревшую документацию на вики Mirador 2. Обратите внимание, что сообщество сосредоточено на Mirador 3 и вряд ли примет запросы на включение или обеспечит поддержку Mirador 2.

Мирадор

Для пользователей Мирадора

Вы можете быстро использовать и настраивать Mirador, создав ремикс mirador-start Glitch.

Мы рекомендуем устанавливать Mirador с помощью менеджера пакетов JavaScript, такого как npm или Yarn.

$ npm install mirador 

# or

$ yarn add mirador

Если вы заинтересованы в интеграции Mirador с плагинами в ваш проект, мы рекомендуем использовать веб-пакет или пакет для интеграции es-версии пакетов. Примеры здесь:

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

Если вы хотите просто встроить Mirador в HTML-страницу без дальнейшей настройки, включите сборку Mirador UMD:

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

Дополнительные примеры внедрения Mirador можно найти по адресу https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript.

Добавление переводов в Mirador

Для получения помощи по добавлению перевода см. src/locales/README.md.

Запуск Mirador локально для разработки

Локальная разработка Mirador требует установки nodejs.

1. Запустите npm install чтобы установить зависимости.

Запуск проекта

$ npm start

Затем перейдите по адресу http://127.0.0.1:4444/.

Создание Мирадора

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

> miradorInstance
{ actions , store }

Пример действия

Добавьте окно:

 store . dispatch ( actions . addWindow ( ) ) ;

Чтобы сфокусировать запуск окна:

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

Проверьте текущее состояние

 store . getState ( ) 

Запуск тестов

$ npm test # For headless CI=true npm test

или постоянно смотреть исходные файлы

$ npm run test:watch

Линтинг проекта

$ npm run lint

Отладка

Локальный экземпляр

Следующие расширения браузера полезны для отладки локального разрабатываемого экземпляра Mirador:

• Инструменты разработчика React
• Инструменты разработчика Redux

Набор тестов

Чтобы отладить набор тестов, запустите:

$ npm run test:debug

затем запустите клиент инспектора nodejs и установите несколько точек останова. См. здесь руководство по отладке с помощью Chrome DevTools.