Getting Started

Mirador uses node.js and a build system to assemble, test, and manage the development resources. If you have never used these tools before, you may need to install them.

1. Install Node, if you haven't already (available at the link above)
2. Install the Grunt command line runner (if you haven't already); on the command line, run npm install -g grunt-cli
3. Clone the mirador repository (if you haven't already done so above); git clone https://github.com/IIIF/mirador.git
4. On the command line, go into the mirador folder
5. Install all dependencies with npm install and bower install. Run grunt

A good practice is to clone the project into a directory that is being served by a running http server such as apache or nginx. However, if you would like to test and develop without using an external server, you may run grunt serve.

Either visit the root folder of the project on your local server, or, if you are using grunt serve, see the example working at localhost:8000.