You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by ch...@apache.org on 2013/03/15 22:50:08 UTC

[34/50] git commit: update readme on how to get started and contributing

update readme on how to get started and contributing


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/8a206130
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/8a206130
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/8a206130

Branch: refs/heads/fauxton-rebase
Commit: 8a206130654aff641a2dbd509f26c6a58ae3767e
Parents: fe6da47
Author: Garren Smith <ga...@gmail.com>
Authored: Mon Mar 11 17:30:38 2013 +0200
Committer: Russell Branca <ch...@gmail.com>
Committed: Fri Mar 15 14:35:41 2013 -0700

----------------------------------------------------------------------
 src/fauxton/readme.md |   31 +++++++++++++++++--------------
 1 files changed, 17 insertions(+), 14 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/8a206130/src/fauxton/readme.md
----------------------------------------------------------------------
diff --git a/src/fauxton/readme.md b/src/fauxton/readme.md
index d5da23f..09632af 100644
--- a/src/fauxton/readme.md
+++ b/src/fauxton/readme.md
@@ -13,17 +13,15 @@ Current items of interest:
   * Data popups for additional db info on \_all_dbs page
   * CouchDB API compliant urls
 
-## Setup ##
+## Setup Fauxton ##
 
-Some recentish version of node.js and npm is required for the local
-development and build tools.
+A recent of [node.js](http://nodejs.org/) and npm is required.
 
 ### CouchDB Setup ###
 
-    git clone https://github.com/cloudant-labs/couchdb/ couchdb-fauxton
-    cd couchdb-fauxton
+    1. Clone the Couchdb repo: https://github.com/apache/couchdb.git or http://git-wip-us.apache.org/repos/asf/couchdb.git
+    cd couchdb
     git checkout fauxton
-    ./bootstrap && ./configure && make dev
 
 ### Fauxton Setup ###
 
@@ -31,7 +29,8 @@ development and build tools.
 
     # Install all dependencies
     npm install
-
+    
+#### (Optional) To avoid a npm global install
     # Add node_modules/.bin to your path
     # export PATH=./node_modules/.bin:$PATH
 		# Or just use the wrappers in ./bin/
@@ -42,15 +41,19 @@ development and build tools.
     # Or fully compiled install
     # ./bin/bbb couchdb
 
-### Start CouchDB with Fauxton Installed ###
+### To Deploy Fauxton
+
+    bbb couchapp_deploy - to deploy to your local [Couchdb instance] (http://localhost:5984/fauxton/_design/fauxton/index.html)
 
-    ../../utils/run &
-    open http://localhost:5984/_utils/fauxton/index.html
+## Understang Fauxton Code layout
 
-### Install as a Couchapp
+Each bit of functionality is its own seperate 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](http://backbonejs.org/) and [Backbone.layoutmanager](https://github.com/tbranyen/backbone.layoutmanager) quite heavily, so best to get an idea how they work. 
+Its 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 compile when Fauxton is deployed. A `resource.js` file is usually 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.
 
-Complete the setup process as above and run:
+## Todo items
 
-    ./bin/bbb couchapp_setup couchapp_install
+Checkout [Jira](https://issues.apache.org/jira/browse/COUCHDB/component/12320406) for a list of items to do. 
 
-Install [phantomjs](http://phantomjs.org/) for tests.