A web service project for searching all UK public library catalogues for books. Part of LibraryData UK project.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
connectors
data
public
views
.deployment
.gitignore
Licence.txt
README.md
deploy.cmd
gulpfile.js
libraries.js
npm-shrinkwrap.json
package.json
server.js
web.config

README.md

Library Catalogues. LibraryData

This is a web service project, with basic front-end, for searching multiple public library catalogues. It is part of the LibraryData UK project.

What it is

In the UK there are around 200 public library authorities, each one with their own Library Management System and associated Online Public Access Catalogue (aside from a few shared systems).

Despite being so many authorities, there are relatively few types of library systems, and fewer suppliers. This project aims to define the interactions with each type of web catalogue, in order to a single set of web services for all UK libraries.

This will provide data aggregation opportunities such as being able to query the UK for the availability of a particular book. Or it could provide functionality to manage a user's account across all their library accounts, such as automating book renewals.

Technologies used

The following key plugins/technologies are used - more specific details in third party licensing section.

Name Description
Node JS Server side JavaScript technology for creating web applications
Web There is a web front-end to this project in order to display a basic search screen.

Authority Data

A list of UK public library authorities is included in the data.json file. This has the library authority name and the type of library service, along with specific data required to search that service e.g. the web URL.

It includes the ONS authority code for each authority. This allows it to be combined with other datasets about that authority that may be published elsewhere.

For example:

Name Code Type URL TestISBN
Aberdeen City S12000033 spydus https://aberdeencity.spydus.co.uk/ 9780747538493

Build

The project uses Node Package Manager (NPM) for package management. On downloading a copy of the project the required dependencies should be installed. Assuming Node is already installed, to build:

npm install

Run and deployment

The solution can be run on a local system with Node JS installed. The solution will be available under localhost at http://localhost:3000/.

node server.js

The solution can be deployed into any production environment set up to run a Node JS Project.

Using the web service

The project implements the following web services.

Service Description
Services Returns stored data about library services (authorities).
Libraries Returns branch/location information, taken from the online catalogue.
Availability Returns availability of a particular book.

Services

Returns selected contents of the data.json file for each service. This can be useful if a developer wished to create an interface that first listed the library authorities to be used in a search filter.

URL Route Description Example
/services Returns a list of library authorities http://localhost:3000/services

Libraries

Returns a list of the library service points for each library service. This may include mobile libraries, and different locations within individual library buildings.

URL Route Description Example
/libraries Returns a list of libraries for each service. http://localhost:3000/libraries
/libraries?service=:service Filters the results to a particular library service. http://localhost:3000/libraries?service=Wiltshire

Availability

Returns data showing the number of available/unavailable copies of the relevant book in each library service point, for each library service.

Route Description Example
/availabilityByISBN/:isbn Retrieves availability of a particular book by passing in ISBN. http://localhost:3000/availabilityByISBN/9780747538493
/availabilityByISBN/:isbn?service=:service Filters the results to a particular library service. http://localhost:3000/availabilityByISBN/9780747538493?service=Gloucestershire

Third party licensing

In addition to Node, the project uses a number of third party plugins.

Web services

Name Description Link Licence
Async A utility module which provides straight-forward, powerful functions for working with asynchronous JavaScript Async MIT
Cheerio Provides parsing and querying of HTML Cheerio on GitHub MIT
Xml2js Converts XML into JavaScript Objects xml2js on GitHub MIT
Express Minimalist web application framework for Node Express on GitHub MIT
Request Simplified HTTP requests framework Request on GitHub Apache

Front-end

Name Description Link Licence
Pug Template engine for NodeJS Pug MIT
Bookstrap 4 Latest beta release of the front-end web development framework (Currently v4.0.0-beta.2) Bootstrap 4 MIT
jQuery Required by Bootstrap and used for general JavaScript shortcuts jQuery MIT
Bookstrap Typahead Provides autocomplete functionality for textboxes, tailored for Bootstrap Bootstrap 3 Typahead on GitHub Open Source
Font Awesome Font and CSS toolkit for vector icons Font Awesome SIL OFL 1.1/MIT
Leaflet Lightweight JavaScript interactive map framework Leaflet Open Source

Licence

Original code licensed with MIT Licence.