tree: 277c2c04599ef8b9bddc6e6244b4e9f8b9c94577 [path history] [tgz]
  1. demo/
  2. packages/
  3. test/
  4. .asf.yaml
  5. .editorconfig
  6. .eslintignore
  7. .eslintrc.js
  8. .gitignore
  9. .lintstagedrc
  10. .mocharc.js
  11. .ratignore
  12. .travis.yml
  13. babel.config.js
  14. CODE_OF_CONDUCT.md
  15. DISCLAIMER
  16. index.html
  17. lerna.json
  18. LICENSE
  19. Makefile
  20. NOTICE
  21. nyc.config.js
  22. package.json
  23. README.md
  24. repolinter.json
  25. SECURITY.md
  26. webpack.config.js
  27. 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

Disclaimer

Apache Annotator is currently undergoing incubation at The Apache Software Foundation.

See the accompanying DISCLAIMER file for details.