Fauxton is the new Web UI for CouchDB. To get it running in development on your machine. Follow the steps below.
Install couchdb from docs here: http://couchdb.readthedocs.org/en/latest/install/index.html
A recent of node.js and npm is required.
- Fork this repo: https://github.com/apache/couchdb-fauxton.git
- 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
cd couchdb-fauxton
npm install
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
Using the dev server is the easiest way to use Fauxton, specially when
developing for it. Copy or symlink the settings.json.default
file if you'd like to see the styletests
addon).
And then...
grunt dev
You should be able to access Fauxton on http://localhost:8000
Follow the "Fauxton Setup" section, edit settings.json variable root where the document will live, e.g. "/_utils/fauxton/" then:
grunt couchdb
This will install the latest version of Fauxton into /share/www/fauxton
You can run the tests either via the command line or your browser.
Command line:
grunt test
Browser: make sure the dev server is running, and enter the path (not URL) to your runner.html
file in your browser.
file://path/to/couchdb-fauxton/test/runner.html
Refreshing the URL will re-run the tests via PhantomJS and in the browser.
To deploy to your local CouchDB instance:
grunt couchapp_deploy
Each bit of functionality is its own separate module or addon. All core modules are stored under app/module
and
any addons that are optional are under app/addons
. We use backbone.js and
Backbone.layoutmanager quite heavily, so best to get an
idea how they work. It's best at this point to read through a couple of the modules and addons to get an idea
of how they work. Two good starting points are app/addon/config
and app/modules/databases
.
Each module must have a base.js
file, this is read and compiled when Fauxton is deployed. A resources.js
file
is usually used for your Backbone.Models and Backbone.Collections, view.js
for your Backbone.Views.
The routes.js
is used to register a URL path for your view along with what layout, data, breadcrumbs and api
point is required for the view.
Check out writing_addons.md for more information on writing your own addons.
Want to get involved? Check out Jira for a list of items to do.
# Development mode, non minified files
npm run couchdebug
# Or fully compiled install
npm run couchdb