tree: a3435176cd975f3a6ae3cdfb193f037792e2dac4 [path history] [tgz]
  1. .asf.yaml
  2. .editorconfig
  3. .eslintignore
  4. .eslintrc.js
  5. .gitignore
  6. .lintstagedrc
  7. .mocharc.js
  8. .travis.yml
  9. CODE_OF_CONDUCT.md
  10. LICENSE
  11. NOTICE
  12. README.md
  13. SECURITY.md
  14. babel.config.js
  15. demo/
  16. index.html
  17. lerna.json
  18. nyc.config.js
  19. package.json
  20. packages/
  21. repolinter.json
  22. test/
  23. webpack.config.js
  24. yarn.lock
README.md

Apache Annotator (incubating) Build Status

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

Development

Requirements

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

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