Quickstart
Now you have NPM installed you easily install the software recommended for the basic storage of the
npm install mongodb
./mongod --dbpath
You will need your own local copy of the Polyanno package and this is easily done using the Github repo right here!
git clone "https://github.com/UoEMainLibrary/polyanno.git"
You will need to make sure that your device has all the necessary software packages to work with Polyanno and this is easily done through the example folder by going inside it on your command line window, and simply typing "npm install".
npm install
npm start
The default address for running is "http://localhost:8080" so visit that address to see the example in action!
If you open up the example.js file then you will see a basic example of a Polyanno application. For more information about the different options available to setup Polyanno to your needs, see the Setup Function section of the longer guide, but if you want to you can just leave the options given in the example provided.
One thing you might want to do though is change the image displayed to your own one.
Polyanno uses the IIIF API framework so all you have to do is change the variable imageViewing to your own IIIF info.json URL.
imageViewing = ""
After you have made the change, simply repeat restart (step 7 again) and refresh the page to see your version in action!
If you are looking to save the results of your annotations then you can use your own storage, or head over to Polyanno Storage to use the ready made package to make things even easier!
See here for more information about it. It is the standard format for loading the large, high resolution images commonly used by museums, libraries, and other collections around the world.
If you don't have any IIIF images of your own then don't worry! You can go find your favourites from amongst the collections of others who are kind enough to share them online.
So there you go! Hope that has been helpful (and not too patronising for the more advanced technical users)! Happy annotating!
There are example files included in the main folder of Polyanno:
- example1.html
- example1.js
- example_server.js
These run a demo through use of the Quickstart instructions.
<script async src="//jsfiddle.net/BluePigeons/mtbwbsty/embed/result/"></script> <div data-role="main" class="ui-content">
<div id="main page" class="container polyanno-page-body">
<div class="row" id="polyanno-top-bar">
<!-- The minimising bar with keyboard buttons go here-->
</div>
<div class="row" id="polyanno-page-body">
<!-- Image Viewer Panel -->
<!-- Editor Boxes go here -->
</div>
</div>
</div>
imageSelected = "https://images.is.ed.ac.uk/luna/servlet/iiif/UoEwmm~2~2~77099~164515/info.json";
var polyanno_setup_options = {
"highlighting": true,
"minimising": true,
"voting": true
};
polyanno_setup(polyanno_setup_options);