commit | c63fde0875766c5215ffa7bfc722f688914ef3dc | [log] [tgz] |
---|---|---|
author | Randall Leeds <randall@apache.org> | Thu Jan 30 21:22:01 2020 -0800 |
committer | Randall Leeds <randall@apache.org> | Thu Jan 30 21:36:22 2020 -0800 |
tree | 9c7f1580d286c5b3487b3cc853e1210bc0c2b4ea | |
parent | 0b94c3b2d1d40f67c9a826d69408f763596e72c0 [diff] |
Add Makefile
Apache Annotator provides annotation enabling code for browsers, servers, and humans.
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
We use Lerna to juggle the various Apache Annotator libraries. If you‘d like to contribute, you’ll need the following:
$ yarn install
$ yarn test
$ 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/
.
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.
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
Apache License 2.0