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
See 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
found here - fork this repo:
git clone https://github.com/apache/couchdb-fauxton.git
- add upstream to the private apache repo:
git remote add upstream https://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git
- go to your cloned copy of the repo (usually
couchdb-fauxton
) and typenpm install
to download all dependencies
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:
npm run dev
Wait until you see the "Fauxton" ascii art on your command line, then you should be able to access Fauxton at
https://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:
npm run couchdb
This will install the latest version of Fauxton into /share/www/
To deploy to your local CouchDB instance:
grunt couchapp_deploy
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.
# 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