https://github.com/jankaszel/simple-annotation-server

💭 Simple HTTP server that implements the Web Annotation specification
https://github.com/jankaszel/simple-annotation-server

annotation linked-data web-annotation

Last synced: 17 days ago
JSON representation

💭 Simple HTTP server that implements the Web Annotation specification

• Host: GitHub
• URL: https://github.com/jankaszel/simple-annotation-server
• Owner: jankaszel
• License: mit
• Created: 2020-06-30T13:13:28.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-10T10:29:37.000Z (about 3 years ago)
• Last Synced: 2024-10-04T12:45:41.915Z (about 1 month ago)
• Topics: annotation, linked-data, web-annotation
• Language: JavaScript
• Homepage:
• Size: 171 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Simple Annotation Server

This is a very simple annotation server intended for testing purposes, implementing both the [Web Annotation Protocol](https://www.w3.org/TR/annotation-protocol/) as well as the [Web Annotation Data Model](https://www.w3.org/TR/annotation-model/) with simple REST-based user management. The server is written in JavaScript and runs in [Node.js](https://nodejs.org/en/), running an in-process LevelDB database.

The server is in active development and its API is subject to frequent change.

### Usage

With a recent version of Node.js installed (`v12` should be sufficient), install all dependencies via `npm install`. Then, start the annotation server via `./bin/server.js index.js`—3000 will be its default port. With each start, the annotation server will generate a new, random API token which will be reported in its terminal output during startup.

#### Creating Users

We'll be using `curl` to access the annotation server's JSON API. To create new user, run the following command, specifying the API token either via GET parameters (`access_token`) or via HTTP bearer authentication:

```bash

curl -XPOST \

  -H 'content-type: application/json' \

  --data '{"name": "alice"}' \

  "http://localhost:3000/?access_token=${API_TOKEN}"

```

In its HTTP response, the server will return a new, random password for that user. We can verify the creation via:

```bash

curl --user alice:${PASSWORD} http://localhost:3000/alice

```

#### Creating Collections

With the newly created user and the assigned password, we'll create a new annotation collection. A collection corresponds to a [Web Annotation Container](https://www.w3.org/TR/annotation-protocol/#annotation-containers), which is a collection of annotations. Each user can have multiple collections.

To create such a collection named ‘Notes’ for Alice, run the following command:

```bash

curl -XPOST \

  --user alice:${PASSWORD} \

  -H 'content-type: application/json' \

  --data '{"name": "notes"}' \

  http://localhost:3000/alice

```

The newly created collection will then be available under her profile:

```bash

curl --user alice:${PASSWORD} http://localhost:3000/alice

```

More TBD.

### API Documentation

TBD.

### License

MIT