Configurable 'Generated: [date]' comments

A while back we added in a comment to the foot of the generated
index.html file containing a "Generated: [data]" text. This has
proven to be extremely useful.

This PR just expands on it a little to make the label itself
configurable. So for environments using different bundles of
the Fauxton code, it can output the build target name, plus
the generation date, e.g.

<!-- Env X. Generated: [date] -->
2 files changed
tree: dc607ade722729b8fb46b00025ff4d8bd245f787
  1. app/
  2. assets/
  3. bin/
  4. build-helper/
  5. tasks/
  6. test/
  7. .eslintignore
  8. .eslintrc
  9. .gitignore
  10. .travis.yml
  13. couchapp.js
  15. favicon.ico
  16. Gruntfile.js
  17. i18n.json.default.json
  18. index.js
  20. package.json
  22. settings.json.default.json
  23. settings.json.sample_external


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

(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