mirador-third-rock

3.0.0-alpha.0 • Public • Published

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

Build Status codecov

Running Mirador locally

  1. Run npm install to install the dependencies.

Starting the project

$ npm start

Then navigate to http://127.0.0.1:4444/__tests__/integration/mirador/

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

Debugging

Useful browser extensions for debugging/development purposes

/mirador-third-rock/

    Package Sidebar

    Install

    npm i mirador-third-rock

    Weekly Downloads

    0

    Version

    3.0.0-alpha.0

    License

    Apache-2.0

    Unpacked Size

    1.73 MB

    Total Files

    5

    Last publish

    Collaborators

    • abhays