Skip to content

Commit

Permalink
Fix Fauxton docs
Browse files Browse the repository at this point in the history
Closes COUCHDB-3123
  • Loading branch information
michellephung committed Dec 3, 2016
1 parent fec0893 commit 59a887a
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 241 deletions.
195 changes: 0 additions & 195 deletions src/fauxton/addons.rst

This file was deleted.

1 change: 0 additions & 1 deletion src/fauxton/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,3 @@ Fauxton
.. toctree::

install
addons
66 changes: 22 additions & 44 deletions src/fauxton/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,66 +12,44 @@
.. _fauxton/install:

============
Installation
============

Recent versions of `node.js`_ and `npm`_ are required.

.. _node.js: http://nodejs.org/
.. _npm: https://npmjs.org/doc/README.html

Get the source
==============

Clone the CouchDB repo::

$ git clone http://git-wip-us.apache.org/repos/asf/couchdb.git
$ cd couchdb

=============
Fauxton Setup
=============

Install all dependencies::
Fauxton is included with CouchDB 2.0, so make sure CouchDB is running, then go to::

couchdb/ $ cd src/fauxton
couchdb/src/fauxton/ $ npm install
http://127.0.0.1:5984/_utils/

.. note::
To avoid a npm global install add ``node_modules/.bin`` to your path::
You can also upgrade to the latest version of Fauxton by using npm::

export PATH=./node_modules/.bin:$PATH
$ npm install -g fauxton
$ fauxton

Or just use the wrappers in ``./bin/``.
(Recent versions of `node.js`_ and `npm`_ are required.)

Development mode, non minified files::

./bin/grunt couchdebug

Or fully compiled install::

./bin/grunt couchdb

Dev Server
==========
.. _node.js: http://nodejs.org/
.. _npm: https://npmjs.org/doc/README.html

Using the dev server is the easiest way to use Fauxton, specially when
developing for it::
Fauxton Visual Guide
====================
You can find the Visual Guide here:
http://couchdb.apache.org/fauxton-visual-guide

grunt dev
Development Server
==================

Deploy Fauxton
==============
Recent versions of `node.js`_ and `npm`_ are required.

Deploy Fauxton to your local CouchDB instance:
.. _node.js: http://nodejs.org/
.. _npm: https://npmjs.org/doc/README.html

./bin/grunt couchapp_deploy
Using the dev server is the easiest way to use Fauxton, specially when developing for it::

The Fauxton be available by `/fauxton/_design/fauxton/index.html
<http://localhost:5984/fauxton/_design/fauxton/index.html>`_
$ git clone https://github.com/apache/couchdb-fauxton.git
$ npm install && npm run dev

Understanding Fauxton Code layout
---------------------------------
=================================

Each bit of functionality is its own separate module or addon.

Expand Down
2 changes: 1 addition & 1 deletion templates/pages/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ <h2>Getting started</h2>
Tutorial
</a>
<br />
<span class="linkdescr">start using CouchDB with Fauxton and
<span class="linkdescr">start using CouchDB with <a href="{{ pathto("fauxton/index") }}">Fauxton</a> and
<a href="{{ pathto("intro/curl") }}">cURL</a></span>
</p>
<p class="biglink">
Expand Down

0 comments on commit 59a887a

Please sign in to comment.