NOTE: This README reflects the latest version of Mirador, Mirador 3. For previous versions, please reference that release's README directly. Latest 2.x release: v.2.7.0

You can quickly use and configure Mirador by remixing the mirador-start Glitch.

We recommend installing Mirador using a JavaScript package manager like npm or yarn.

$ npm install mirador 

# or

$ yarn add mirador

If you are interested in integrating Mirador with plugins into your project, we recommend using webpack or parcel to integrate the es version of the packages. Examples are here:

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

For help with adding a translation, see src/locales/README.md

Mirador local development requires nodejs to be installed.

1. Run npm install to install the dependencies.

$ npm start

Then navigate to http:https://127.0.0.1:4444/

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

> miradorInstance
{ actions, store }

Add a window:

store.dispatch(actions.addWindow());

To focus a window run:

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

store.getState()

$ npm test # For headless CI=true npm test

or to continually watch the source files

$ npm run test:watch

$ npm run lint

Useful browser extensions for debugging/development purposes

• React DevTools
• Redux DevTools