Neato Polyester Material


    1.1.9 • Public • Published


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

    Install via NPM

    You can use the latest release of Fauxton via npm:

    npm install -g fauxton

    See fauxton --help for extra options.

    Setting up Fauxton

    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: and make sure you have a cloned local copy
    3. add upstream to the main git repo: git remote add git-repo
    4. add upstream to the private apache repo: git remote add upstream
    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

    Running Fauxton

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

    The Dev Server

    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

    Preparing a Fauxton Release

    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 Fauxton

    To deploy to your local CouchDB instance:

    grunt couchapp_deploy

    Build pipeline overview

    During a release build we are creating a folder called dist/tmp-out. 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.

    (Optional) To avoid a npm global install

    # Development mode, non minified files
    npm run couchdebug
    # Or fully compiled install
    npm run couchdb

    More information

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

    -- The Fauxton Team


    npm i testfauxton

    DownloadsWeekly Downloads






    Last publish


    • robertkowalski