Git Product home page Git Product logo

anno-proto-coucho's Introduction

Web Annotation Protocol on CouchDB

Apache CouchDB's HTTP API is quite similar to the Web Annotation Protocol except the later is specific to Annotation.

This project closes the loop by providing a set of CouchApp functions (_update, _show, etc) that add the remaining Web Annotation Protocol specific semantics.

Usage

  1. npm install && npm install -g gulp
  2. Copy config.json.sample to config.json
  3. Change config.json to match your setup.
  4. gulp (or only gulp apps or gulp docs)
  5. Send Web Annotation Protocol requests to the URL you set in config.json plus _design/anno/_rewrite/
  6. (optional) Setup a Virtual Host to make the URL above prettier.

Sample Requests

Assuming your setup matches mine ๐Ÿ˜บ

License

Apache License 2.0

anno-proto-coucho's People

Contributors

bigbluehat avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

anno-proto-coucho's Issues

Etag's on _show can't match document state...

Sadly, Etag is not over-ridable from a _show function, so there's no way to do this entirely as a "CouchApp."

The Web Annotation Protocol makes some requirements on data and shape that go beyond just validation--id set on new content must move to canonical (and such). Consequently, it's not possible to do both the transformations (which _show/_list can do) and handle the header state from within the database itself.

It will either need some code in front (i.e. a server) or some plug-in style code. In either case, this won't be a drop-in feature of any future CouchDB. ๐Ÿ˜ฟ

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.