As an app developer you probably don't want to clone this repository. Rather, you'd want a build of it, preferably one that includes the documentation too. However, since this project is still under active development no builds are available, so you would have to do it yourself anyway, see the section below on build instructions.
CIP is an interface web service to an asset management system, called Cumulus, which used by a variety of institutions. Read more about CIP and Cumulus on http://www.canto.com/what-we-offer/.
cip.js provides a convenient object-relation layer on top of the CIP infrastructure to make it easier to make various operations on the collections exposed by CIP. cip.js does only supports read-only for the momemt.
The library uses qwest for keeping track of the AJAX connections. qwest is already included in cip.js and uses the MIT license.
For every institution which exposes a CIP to the internet, the cip.js library needs some institution-specific setup and a 'handle' for that particular setup.
If you are looking for one such institution-specific setup, natmus.js provides a 'handle' for cip.js that allows access to the collections of the National Museum of Denmark.
Make sure you have Google's Closure Compiler, Node.js and JSDoc installed before proceeding.
- Clone this repository.
- Review
build.shand change the path tojsdoc.jsto one that matches your system. - Run
build.sh.
This project is primarily maintained by @jchillerup from BIT BLUEPRINT for the National Museum of Denmark.
The BIT BLUEPRINT team is available by email or live by IRC on #bitblueprint at irc.freenode.net.