uv-app-starter

Get started building a IIIF-enabled website using the Universal Viewer and host it for free on Github Pages.

Setup

• Fork this repo on github to your personal account.

• Rename the repo, e.g. "my-collection"

• Clone the repo to your desktop

• Check out the gh-pages branch

• Run npm install

• Organise your files and folders in /collection using the biiif conventions

• Run npm start to preview on http://localhost:8888

• When ready to publish to Github Pages, in the package.json scripts section, assuming your Github username is for example @edsilv, change:

   "dist": "biiif collection -u https://username.github.io/uv-app-starter-fork/collection"
  

  to:

   "dist": "biiif collection -u https://edsilv.github.io/my-collection/collection"
  

• Now run npm run dist

• Add your changes to the gh-pages branch, and git push origin gh-pages

• Your site should now be available at https://edsilv.github.io/my-collection/