CouchApp Development Tools¶
- The CouchApp Filesystem Mapping -
couchapp.pyand erica (mentioned below) implement a consistent filesystem-to-design-document mapping
The original CouchApp command line tools were created in 2008 / 2009 by
@benoitc and @jchris. They still work, and have been feature complete
for a long time.
couchapp has been replaced and is compatible with the
The simplest way to develop a couchapp would be to use
curl from the
The CouchApp command line tool is used to generate code templates in your application and to push your changes to an instance of CouchDB, among other things. Here is how to get started with the CouchApp command line tool:
- Installing couchapp
- Couchapp configuration
- The couchapp command line tool
- Extending the couchapp command line tool
- Using couchapp with multiple design documents
There can be confusion with the term CouchApp because it can refer to
this tool, named CouchApp, or a general application served from
CouchDB. This is probably due to the fact that the CouchApp command line
tool, as known as
couchapp.py , was the first full way of developing a
This is an alternative tooling to the Python couchapp utility that is instead written in Node.js. It uses a much simpler folder structure than it’s Python counterpart and is a generally more minimalist/simplified way of writing couchapps. Note that you cannot use Python couchapp to push couchapps written using node.couchapp.js into CouchDB and vice versa.
erica is an Erlang-based command line tool that is compatible with the Python and Node.js CouchApp tools.
A comprehensive, framework-agnostic build tool for CouchApps.
The Kanso command line tool can build projects designed for
node.couchapp.js, or even the Python couchapp tool, while providing many
other options for building your app. These build steps and other code
can be shared using the online package
repository. Compiling coffee-script,
CSS templates etc. is as easy as including the relevant package.
NPM for CouchApps¶
soca is a command line tool written in ruby for building and pushing couchapps. It is similar to the canonical couchapp python tool, with a number of key differences:
- local directories do not have to map 1-1 to the design docs directory
- lifecycle management & deployment hooks for easily adding or modifying the design document with ruby tools or plugins.
- architected around using Sammy.js, instead of Evently, which is bundled with the python tool. Sammy.js is a Sinatra inspired browser-side RESTframework which is used by default.
Unlike a traditional couchapp, a soca couchapp is one way - your source
directory structure is actually ‘compiled’ into into the couchapp
_design document format.
Compile time plugins: