mirador

️このプロジェクトは、Mirador の最新バージョンである Mirador 3 用です。 Mirador 2 については、ProjectMirador/mirador2 または Mirador 2 wiki のレガシー ドキュメントを参照してください。コミュニティは Mirador 3 に重点を置いており、プル リクエストを受け入れたり、Mirador 2 のサポートを提供したりする可能性は低いことに注意してください。

ミラドール

ミラドールユーザー向け

mirador-start グリッチをリミックスすることで、Mirador をすばやく使用して構成できます。

npm や Yarn などの JavaScript パッケージ マネージャーを使用して Mirador をインストールすることをお勧めします。

$ npm install mirador 

# or

$ yarn add mirador

Mirador とプラグインをプロジェクトに統合することに興味がある場合は、webpack または Parcel を使用してパッケージの 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 を使用したデバッグのガイドについては、ここを参照してください。