README.md

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

Mirador

For Mirador Users

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

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

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

Adding translations to Mirador

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

Running Mirador locally

Mirador local development requires nodejs to be installed.

1. Run npm install to install the dependencies.

Starting the project

$ npm start

Then navigate to http://127.0.0.1:4444/

Instantiating Mirador

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

> miradorInstance
{ actions, store }

Example Action

Add a window:

store.dispatch(actions.addWindow());

To focus a window run:

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

Check current state

store.getState()

Running the tests

$ npm test # For headless CI=true npm test

or to continually watch the source files

$ npm run test:watch

Linting the project

$ npm run lint