express-pouchdb

Express submodule with a CouchDB style REST interface to PouchDB.

npm install express-pouchdb
1 downloads in the last day
29 downloads in the last week
79 downloads in the last month

express-pouchdb

An Express submodule with a CouchDB style REST interface to PouchDB.

Introduction

The express-pouchdb module is a fully qualified Express application with routing defined to mimic most of the CouchDB REST API, and whose behavior is handled by PouchDB. The intention is for express-pouchdb to be mounted into other Express apps for extended usability. A simple example of this is pouchdb-server, which is primarily used as a quick-and-dirty drop-in replacement for CouchDB in Node.js.

Screencasts

Installation

$ npm install express-pouchdb

Example Usage

Here's a sample Express app, which we'll name app.js.

var express = require('express')
  , app     = express();

app.configure(function () {
  app.use(express.logger('tiny'));
  app.use('/db', require('express-pouchdb'));
});

app.listen(3000);

Now we can run this little guy and find each of express-pouch's routes at the /db prefix.

$ node app.js &
$ curl http://localhost:3000/db/
GET / 200 56 - 7 ms
{
  "express-pouchdb": "Welcome!",
  "version": "0.2.0"
}

Note, express-pouchdb bundles its own JSON parsing middleware which conflicts with express.bodyParser(). Please avoid using express.bodyParser(). Rather, you can use express.urlencoded() and express.multipart() alongside the express-pouchdb JSON middleware and you should find the results to be the same as you would have expected with express.bodyParser().

app.configure(function () {
  app.use(express.urlencoded());
  app.use(express.multipart());
  app.use(require('express-pouchdb'));
});

Contributing

Want to help me make this thing awesome? Great! Here's how you should get started.

  1. Because PouchDB is still developing so rapidly, you'll want to clone git@github.com:daleharvey/pouchdb.git, and run npm link from the root folder of your clone.
  2. Fork express-pouchdb, and clone it to your local machine.
  3. From the root folder of your clone run npm link pouchdb to install PouchDB from your local repository from Step 1.
  4. npm install

Please make your changes on a separate branch whose name reflects your changes, push them to your fork, and open a pull request! I haven't defined a formal styleguide, so please take care to maintain the existing coding style.

Contributors

A huge thanks goes out to all of the following people for helping me get this to where it is now.

License

Copyright (c) 2013 Nick Thompson

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you