Add `yarn validate` for JSON testing
[incubator-annotator.git] / README.md
1 # [Apache Annotator](http://annotator.apache.org/) (incubating) [![Build Status](https://travis-ci.org/apache/incubator-annotator.svg?branch=master)](https://travis-ci.org/apache/incubator-annotator)
2
3 > Apache Annotator provides annotation enabling code for browsers, servers,
4 > and humans.
5
6 * [`dev@` Mailing List archive](http://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/)
7 * [Issue Tracker](https://issues.apache.org/jira/browse/ANNO)
8 * [Wiki](https://cwiki.apache.org/confluence/display/ANNO)
9
10 ## Usage
11
12 We're currently pre-releasing development copies of each library that makes up
13 the sum total of Apache Annotator's code. You can grab any of them from our
14 [npm organization](https://www.npmjs.com/org/annotator).
15
16 ```sh
17 $ # for example...
18 $ npm install --save @annotator/dom
19 ```
20
21 ##### Requirements
22
23 - [node](https://nodejs.org) >= 8.x
24 - [yarn](https://www.yarnpkg.com/) >= 1.5.1
25
26
27 ## Development
28
29 ##### Requirements
30
31 We use [Lerna](https://lernajs.io/) to juggle the various Apache Annotator
32 libraries. If you'd like to contribute, you'll need the following:
33
34 - [node](https://nodejs.org) >= 8.x
35 - [yarn](https://www.yarnpkg.com/) >= 1.5.1
36
37 ##### Setup
38
39 ```sh
40 $ yarn install
41 ```
42
43 ##### Test
44
45 ```sh
46 $ yarn test
47 ```
48
49 ##### Run localhost demo server
50
51 ```sh
52 $ yarn start
53 ```
54
55 Once the test server has started, you can browse a local demo, and run tests in
56 a browser by visiting `http://localhost:8080/`.
57
58
59 ## Web Annotation Data Model Validation
60
61 If you have any Web Annotation Data Model JSON documents, you can validate them
62 using the `validate` script:
63
64
65 ```sh
66 $ yarn validate --url ../anno1.json
67 ```
68
69
70 # License
71
72 Apache License 2.0