Apache Annotator (incubating)

Apache Annotator provides annotation enabling code for browsers, servers, and humans.

Usage

We‘re currently pre-releasing development copies of each library that makes up the sum total of Apache Annotator’s code. You can grab any of them from our npm organization.

$ # for example...
$ npm install --save @annotator/dom

Requirements

node >= 8.x
yarn >= 1.5.1

Development

Requirements

We use Lerna to juggle the various Apache Annotator libraries. If you‘d like to contribute, you’ll need the following:

node >= 8.x
yarn >= 1.5.1

Setup

$ yarn install

Test

$ yarn test

Run localhost demo server

$ yarn start

Once the test server has started, you can browse a local demo, and run tests in a browser by visiting http://localhost:8080/.

Web Annotation Data Model Validation

If you have any Web Annotation Data Model JSON documents, you can validate them using the validate script:

$ yarn validate --url https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json

With the --url option you can pass in a URL or a local path to a JSON file.

Examples

Valid:

https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/correct/anno1.json

Invalid:

https://raw.githubusercontent.com/w3c/web-annotation-tests/master/tools/samples/incorrect/anno1.json

(More)

License

Apache License 2.0