|
1 | | -ldnode |
2 | | -============== |
| 1 | +# ldnode |
3 | 2 |
|
4 | 3 | [](https://travis-ci.org/linkeddata/ldnode) |
5 | 4 |
|
6 | | -All you need to run distributed linked data apps on top of a bit of file system. Typically used as a proxy, with Apache doing the ACLs and GETs, just to do the fast real-time patch of data resources. |
| 5 | +Linked Data Platform server based on [rdflib.js](https://github.com/linkeddata/rdflib.js) and [node.js](https://nodejs.org/). This is all you need to run distributed linked data apps on top of the file system. |
7 | 6 |
|
8 | | -Linked Data Platform server based on rdflib.js and node.js |
| 7 | +## Features |
9 | 8 |
|
10 | | -Using the rdflib.js library originally developed for the browser environment |
11 | | -and since ported to node.js, a linked data server supporting the POST and PATCH. |
12 | | -Minimum requirement is to suport the client side of the same library, which currently (September 2014) |
13 | | -uses a form of SPARQL-Patch via POST. |
| 9 | +- [x] GET, PUT and PATCH support |
| 10 | +- [x] Proxy for cross-site data access |
| 11 | +- [x] Access control using RDF ACLs |
| 12 | +- [x] WebID Authentication |
| 13 | +- [x] Real-time live updates (using websokets) |
| 14 | +- [ ] Mount as express' router |
14 | 15 |
|
15 | | -Features |
16 | 16 |
|
17 | | -- handles GET, PUT and PATCH |
18 | | -- includes proxy for cross-site data access |
| 17 | +## Install |
19 | 18 |
|
20 | | -Goals (see issues): |
21 | | - |
22 | | -- provide Access control using RDF ACLs |
23 | | -- provide authentication using webid |
24 | | -- real-time live updates using websokets (etc) |
25 | | - |
26 | | - |
27 | | -Install |
28 | | -------- |
29 | | - |
30 | | - npm install |
31 | | - |
32 | | -All dependencies are installed to the local node_modules directory and no other steps are necessary. |
33 | | - |
34 | | - |
35 | | -Command line tool |
36 | | ------------------ |
37 | | - |
38 | | -You can run `ldnode` straight from your command line, by running `server.js` or installing `ldnode` globally. |
| 19 | +``` |
| 20 | +npm install |
| 21 | +``` |
39 | 22 |
|
| 23 | +## Command line tool |
40 | 24 |
|
41 | 25 | npm install -g ldnode |
42 | 26 |
|
@@ -66,21 +50,13 @@ The command line tool has the following options |
66 | 50 | --cert Path to the private key used to enable webid authentication |
67 | 51 | -h --help Print this list and exit. |
68 | 52 |
|
69 | | -Tests |
70 | | ------- |
71 | | - |
72 | | -To run the test suite run |
73 | | - |
74 | | - npm test |
75 | | - |
76 | | -from the main directory. The test suite assumes the test server is already running. To start the server run |
77 | | - |
78 | | - make |
79 | | - |
80 | | -from the main directory in another terminal. |
81 | | - |
82 | | -There is another suite of tests in the test directory that covers the SPARQL-PATCH functionality. To run it run |
| 53 | +## Tests |
83 | 54 |
|
84 | | - make |
| 55 | +The tests assume that there is a running ldnode. |
85 | 56 |
|
86 | | -from the test directory. This suite also assumes the test server is already running. Eventually all tests in this second suite will be moved to the first one. |
| 57 | +```bash |
| 58 | +# on a terminal |
| 59 | +make |
| 60 | +# on another terminal |
| 61 | +npm test |
| 62 | +``` |
0 commit comments