mirador

️ Este projeto é para o Mirador 3, a versão mais recente do Mirador. Para o Mirador 2, consulte ProjectMirador/mirador2 ou a documentação legada no wiki do Mirador 2. Observe que o foco da comunidade está no Mirador 3 e é improvável que aceite solicitações pull ou forneça suporte para o Mirador 2.

Mirante

Para usuários do Mirador

Você pode usar e configurar rapidamente o Mirador remixando o mirador-start Glitch.

Recomendamos instalar o Mirador usando um gerenciador de pacotes JavaScript como npm ou yarn.

$ npm install mirador 

# or

$ yarn add mirador

Se você estiver interessado em integrar Mirador com plugins em seu projeto, recomendamos usar webpack ou package para integrar a versão es dos pacotes. Exemplos estão aqui:

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

Se você deseja simplesmente incorporar o Mirador em uma página HTML sem personalização adicional, inclua a compilação Mirador UMD:

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

Mais exemplos de incorporação do Mirador podem ser encontrados em https://github.com/ProjectMirador/mirador/wiki/M3-Embedding-in-Another-Environment#in-an-html-document-with-javascript.

Adicionando traduções ao Mirador

Para obter ajuda com a adição de uma tradução, consulte src/locales/README.md

Executando o Mirador localmente para desenvolvimento

O desenvolvimento local do Mirador requer a instalação do nodejs.

1. Execute npm install para instalar as dependências.

Iniciando o projeto

$ npm start

Em seguida, navegue para http://127.0.0.1:4444/

Instanciando o Mirador

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

> miradorInstance
{ actions , store }

Exemplo de ação

Adicione uma janela:

 store . dispatch ( actions . addWindow ( ) ) ;

Para focar uma execução de janela:

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

Verifique o estado atual

 store . getState ( ) 

Executando os testes

$ npm test # For headless CI=true npm test

ou para observar continuamente os arquivos de origem

$ npm run test:watch

Lintando o projeto

$ npm run lint

Depuração

Instância local

As seguintes extensões de navegador são úteis para depurar uma instância de desenvolvimento local do Mirador:

• React DevTools
• Redux DevTools

Conjunto de testes

Para depurar o conjunto de testes, execute:

$ npm run test:debug

em seguida, crie um cliente inspetor nodejs e defina alguns pontos de interrupção. Veja aqui um guia para depuração com Chrome DevTools.