Nuclear Pizza Machine

    mirador

    3.3.0 • Public • Published

    ⚠️ This project is for Mirador 3, the latest version of Mirador. For Mirador 2, please see ProjectMirador/mirador2 or legacy documentation on the Mirador 2 wiki. Please note that the community's focus is on Mirador 3, and are unlikely to accept pull requests or provide support for Mirador 2.

    Mirador

    Node.js CI codecov

    For Mirador Users

    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

    Adding translations to Mirador

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

    Running Mirador locally for development

    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

    Debugging

    Local instance

    The following browser extensions are useful for debugging a local development instance of Mirador:

    Test suite

    To debug the test suite, run:

    $ npm run test:debug

    then spin up a nodejs inspector client and set some breakpoints. See here for a guide to debugging with Chrome DevTools.

    Keywords

    none

    Install

    npm i mirador

    DownloadsWeekly Downloads

    1,628

    Version

    3.3.0

    License

    Apache-2.0

    Unpacked Size

    12.5 MB

    Total Files

    636

    Last publish

    Collaborators

    • budak
    • marlo-longley
    • corylown
    • mejackreed
    • aeschylus
    • jessie.keck
    • cbeer
    • lutzhelm
    • camillevilla