Code Monkey home page Code Monkey logo

express-iiif's Introduction

express-iiif

express-iiif is middleware for Express.js to run an Image API 3.0 compatible IIIF server.

Installation

npm install express-iiif

Usage

Add the middleware to any Express.js application and provide the path to the directory containing your images.

import express from "express";
import iiif from "express-iiif";

const app = express();

app.use(
  "/iiif",
  iiif({
    imageDir: "./images",
  })
);

app.listen(3000, () => {
  console.log("⚡️ Server is running at http://localhost:3000");
});

These URLs become available:

For an overview of all available transformations and explaination of the Image Request URI Syntax, vist the Image API 3.0 specification.

For an example application with OpenSeadragon viewer, visit the GitHub Repository examples folder.

Development

Run the example application from the /examples folder with npm run dev and browse to http://localhost:3000. To build javascript files from the /src to the /dist folder run npm run build or npm run build:watch.

Options

Option Required Type Description Example
imageDir Yes string The path to the directory containing the images. /images
baseUrl No string The absolute URL of the IIIF server. http://example.com/path/to/iiif
maxWidth No number https://iiif.io/api/image/3.0/#42-size 1000
maxHeight No number https://iiif.io/api/image/3.0/#42-size 1000
maxArea No number https://iiif.io/api/image/3.0/#42-size 500000
quality No string https://iiif.io/api/image/3.0/#43-quality gray
rights No string https://iiif.io/api/image/3.0/#56-rights https://rightsstatements.org/page/InC-EDU/1.0/?language=en

License

BSD 3-Clause License

express-iiif's People

Contributors

tvanbeek avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.