Git Product home page Git Product logo

annotator-couchapp's Introduction

Annotator CouchApp

AnnotatorJS provides a Store plugin which inturn uses a simple Storage API that (thankfully!) maps quite nicely to Apache CouchDB's.

So...I built a 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 (or something that supports the CouchApp File System Mapping)
  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)
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

annotator-couchapp's People

Contributors

bigbluehat avatar

Stargazers

avatar avatar avatar avatar avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

nagyistoce aleray

annotator-couchapp's Issues

no highlight after a successful "create"

Hi,

I'm trying to use your code with couchdb (not pouchdb). But for some reason it does not trigger any highlight not the "annotationCreated" hook.

I suspect this is because your/couchdb api implementation does not follow the standard annotator (2.x) API and returns {"ok":true,"id":"xxx","rev":"xxx"} instead of the document itself.

If I change annotator http storage code from:

HttpStorage.prototype.create = function (annotation) { 
    return this._apiRequest('create', annotation);
};

to:

HttpStorage.prototype.create = function (annotation) { 
    this._apiRequest('create', annotation);
    return annotation;
};

then it works.

What do you think? What is the best way to solve this?

Thanks

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.