Fauxton is a modular CouchDB dashboard and Futon replacement.


Fauxton is the new Web UI for CouchDB. To get it running in development on your machine. Follow the steps below.

You can use the latest release of Fauxton via npm:

npm install -g fauxton

See fauxton --help for extra options.

Please note that a recent installation of node.js and npm is required.

  1. make sure you have CouchDB installed. Instructions on how to install it can be
    found here
  2. fork this repo: https://github.com/apache/couchdb-fauxton.git and make sure you have a cloned local copy
  3. add upstream to the main git repo: git remote add git-repo https://github.com/apache/couchdb-fauxton.git
  4. add upstream to the private apache repo: git remote add upstream http://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git
  5. go to your cloned copy of the repo (usually couchdb-fauxton) and type npm install to download all dependencies
  6. install the grunt-cli (grunt command line interface)

In case you don't have the Grunt command line interface installed, run the following command:

npm install -g grunt-cli

If you run into a permissions problem, run that last command as an administrator:

sudo npm install -g grunt-cli

NOTE: Before you run Fauxton, don't forget to start CouchDB!

Using the dev server is the easiest way to use Fauxton, especially when developing for it. In the cloned repo folder, type:

grunt dev

Wait until you see the "Fauxton" ascii art on your command line, then you should be able to access Fauxton at http://localhost:8000

Follow the "Setting up Fauxton" section above, then edit the settings.json variable root where the document will live, e.g. /_utils/. Then type:

grunt couchdb

This will install the latest version of Fauxton into /share/www/

To deploy to your local CouchDB instance:

grunt couchapp_deploy
# Development mode, non minified files
npm run couchdebug

# Or fully compiled install
npm run couchdb

Check out the following pages for a lot more information about Fauxton:

-- The Fauxton Team