During the workshop you will be learning to customize Mirador while following along on your local computer. We ask that you set up your development environment in advance of the workshop. Developers may do this in a variety of different ways. Please do this however you feel most comfortable. You will need to be able to do the following:
- Run this Mirador application using Webpack
- Edit files in this repository and see the changes in a browser
We recommend using the Firefox or Chrome browser for development with the following add-ons:
- node.js version v12.18.0 or greater (Download node.js)
- npm version v6.14.4 or greater (Download npm)
Clone https://github.com/ProjectMirador/mirador-workshop
- Run
$ npm install
from a terminal to install dependencies - Run
$ npm start
to start a development server and build a development version of your Mirador installation. - The browser should open a page that when eventually built you will see a Mirador viewer load at
http://localhost:8080
Command | Description |
---|---|
npm start |
Builds your Mirador project and starts a server that runs at http://localhost:8080 |
npm build |
Builds a production ready build of your Mirador project in /dist |