https://github.com/bigbluehat/annotator-couchapp

[Experimental] Apache CouchDB-based Annotator Store
https://github.com/bigbluehat/annotator-couchapp

annotatorjs couchapp couchdb pouchdb

Last synced: 2 months ago
JSON representation

[Experimental] Apache CouchDB-based Annotator Store

• Host: GitHub
• URL: https://github.com/bigbluehat/annotator-couchapp
• Owner: BigBlueHat
• Created: 2014-07-19T19:54:33.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-03-16T19:22:11.000Z (almost 8 years ago)
• Last Synced: 2024-10-04T18:01:22.187Z (3 months ago)
• Topics: annotatorjs, couchapp, couchdb, pouchdb
• Language: JavaScript
• Homepage:
• Size: 466 KB
• Stars: 8
• Watchers: 6
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Annotator CouchApp

[AnnotatorJS](http://annotatorjs.org/) provides a

[Store plugin](http://docs.annotatorjs.org/en/latest/plugins/store.html)

which inturn uses a simple

[Storage API](http://docs.annotatorjs.org/en/latest/storage.html)

that (thankfully!) maps quite nicely to [Apache CouchDB](http://couchdb.apache.org/)'s.

So...I built a [CouchApp](http://github.com/couchapp) to fill in the missing bits.

## Install

1. `npm i` to install dependencies

2. `npm run anno` to build annotator

3. `npm run dev` to build the annotator-pouchdb add-on

4. Download [couchapp.py](http://github.com/couchapp/couchapp) (or something that

supports the [CouchApp File System Mapping](https://github.com/couchapp/couchapp/wiki/Complete-Filesystem-to-Design-Doc-Mapping-Example))

5. `couchapp push . http://localhost:5984/annotator`

6. Add this (or similar) code to an HTML page hosted form that database (or that can write to it

...see [CORS](http://docs.couchdb.org/en/latest/config/http.html?highlight=bind_address#config-cors))

```js

var annotator = $('#content').annotator();

annotator.annotator('addPlugin', 'Store', {

  prefix: 'http://localhost:5984/annotator/_design/annotator/_rewrite'

});

```

## Early days, yet.

AnnotatorJS has plugins for Auth, Permissions, and a few other Storage-facing

things. It'd be super to add support for them here.

Patches welcome!

## License

Apache License 2.0