mirador

️ 본 프로젝트는 Mirador의 최신 버전인 Mirador 3에 대한 것입니다. Mirador 2의 경우 ProjectMirador/mirador2 또는 Mirador 2 wiki의 레거시 문서를 참조하세요. 커뮤니티의 초점은 Mirador 3에 있으며 풀 요청을 수락하거나 Mirador 2에 대한 지원을 제공할 가능성이 낮습니다.

미라도르

Mirador 사용자의 경우

mirador-start Glitch를 리믹스하여 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/로 이동합니다.

Mirador 인스턴스화

 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 DevTools
• Redux DevTools

테스트 스위트

테스트 스위트를 디버그하려면 다음을 실행하십시오.

$ npm run test:debug

그런 다음 nodejs 검사기 클라이언트를 가동하고 몇 가지 중단점을 설정하세요. Chrome DevTools를 사용한 디버깅 가이드는 여기를 참조하세요.