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 fauxton
fauxton --help for extra options.
Please note that a recent installation of node.js and npm is required.
- make sure you have CouchDB installed. Instructions on how to install it can be
- fork this repo:
https://github.com/apache/couchdb-fauxton.gitand make sure you have a cloned local copy
- add upstream to the main git repo:
git remote add git-repo https://github.com/apache/couchdb-fauxton.git
- add upstream to the private apache repo:
git remote add upstream http://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git
- go to your cloned copy of the repo (usually
couchdb-fauxton) and type
npm installto download all dependencies
- 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:
Wait until you see the "Fauxton" ascii art on your command line, then you should be able to access Fauxton at
Follow the "Setting up Fauxton" section above, then edit the
settings.json variable root where the document will live,
/_utils/. Then type:
This will install the latest version of Fauxton into
To deploy to your local CouchDB instance:
During a release build we are creating a folder called
It contains all files that are just intermediate results for the final
release artifact. Once everything is finished the files are copied from
tmp-out to their final destination,
dist/release where they are
part of the deployable release artifact.
# 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