Skip to content
/ viewpoint Public template
generated from nyu-dh/viewpoint

wip ~ create & embed iiif views from query params 👀

Notifications You must be signed in to change notification settings

middlicomp/viewpoint

Repository files navigation

viewpoint

Using the template

  1. Click the Use this template button and select where you would like to copy this repo to.
  2. Next, open the svelte.config.js file in your new repo using GitHub editor and change the following line
    base: '/viewpoint';
    to the name of your repository, e.g., my-repo
    base: '/my-repo';
  3. Open the src/lib/vars/constants.js file in your new repo using GitHub editor and change the following lines:
    export const siteTitle = 'viewpoint';
    export const siteDescription = 'embeddable iiif viewers with svelte-kit';
    export const sampleManifests = [
    	'https://purl.stanford.edu/wr796rv9498/iiif/manifest',
    	'https://gallica.bnf.fr/iiif/ark:/12148/btv1b90266728/manifest.json',
    	'https://iiif.bodleian.ox.ac.uk/iiif/manifest/e32a277e-91e2-4a6d-8ba6-cc4bad230410.json',
    	'https://jsonstorage.net/api/items/1a6e2d6e-fa90-4d44-95a5-35bb6c011aa2',
    	'https://www.e-codices.unifr.ch/metadata/iiif/bc-s-0007/manifest.json',
    	'https://www.e-codices.unifr.ch/metadata/iiif/bc-s-0058/manifest.json',
    	'https://www.e-codices.unifr.ch/metadata/iiif/snm-AG002760/manifest.json',
    	'https://www.e-codices.unifr.ch/metadata/iiif/hmtg-T09393/manifest.json'
    ];
  4. Go to your repo's homepage and navigate to Settings > Pages (on the left panel). Under Source select Branch gh-pages and click Save.

Note: If gh-pages doesn't show up as an option, make sure you have Actions enabled and that your first gh-deploy.yml action ran successfully in your Actions panel. This action creates the built site in the gh-pages branch.

Local development

Prerequisites

Steps

  1. Clone the repo
    git clone [email protected]:middlicomp/viewpoint-template.git && cd viewpoint-template
  2. Install project node version (specified in .nvmrc)
    nvm install
  3. Install npm packages
    npm install
  4. Run the dev server
    npm run dev
  5. Open in browser at http://localhost:3000/viewpoint-template/
  6. Quit the server with Ctrl-c.
  7. Auto-format code
    npm run format
  8. Lint code
    npm run lint

About

wip ~ create & embed iiif views from query params 👀

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Languages