README.md

pouchdb-nextjs-router

A next.js API submodule with a CouchDB style REST interface to PouchDB

pouchdb-nextjs-router is a routing module that provides the minimal API to add a PouchDB HTTP endpoint to a next.js application. It features a powerful middleware system that allows you to customize its behaviour without hacking into the module.

It is designed to be mounted into a next.js API route to provide an extensible endpoint for PouchDB instances to sync with.

The code is forked from https://github.com/pouchdb/pouchdb-express-router.

I wrote this module because pouchdb-express-router simply doesn't work inside nextjs beyond the basic paths, and fails to pass the whole pouchdb testsuite.

The module is fully functional but has not been widely used in production yet.

Installation

Install with your favorite package manager.

npm install --save pouchdb-nextjs-router

Documentation

1. Basic usage
2. Advanced usage, with middleware
3. Setup the development environment
4. Performance
5. Testing

The repo is actually a next.js app that uses pouchdb-nextjs-router in various API routes for testing. See the code for :

1. a basic example.
2. an advanced example with middleware.

Contributing

Pull requests are welcome.

• For major changes, please open an issue first to discuss what you would like to change.
• Your pull request name must respect the @commitlint/config-conventional syntax.
• Your pull request must pass the latest full pouchdb test suite, the router own test suite and provide it own relevant integration tests.

More info

• Changelog
• Licensed under the MIT License