couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From robertkowal...@apache.org
Subject fauxton commit: updated refs/heads/master to 4f53986
Date Fri, 17 Oct 2014 21:05:39 GMT
Repository: couchdb-fauxton
Updated Branches:
  refs/heads/master 332c7b535 -> 4f539862a


minor README update

- clarifies how to run the tests via your browser
- cleans up a few small typos/grammar etc.


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

Branch: refs/heads/master
Commit: 4f539862a5cc565d7980c298a987c2c389124cee
Parents: 332c7b5
Author: Benjamin Keen <ben.keen@gmail.com>
Authored: Fri Oct 17 10:52:29 2014 -0700
Committer: Benjamin Keen <ben.keen@gmail.com>
Committed: Fri Oct 17 10:57:11 2014 -0700

----------------------------------------------------------------------
 readme.md | 73 +++++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 44 insertions(+), 29 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/blob/4f539862/readme.md
----------------------------------------------------------------------
diff --git a/readme.md b/readme.md
index a48d0b8..3c6f707 100644
--- a/readme.md
+++ b/readme.md
@@ -3,25 +3,25 @@ Fauxton
 
 Fauxton is the new Web UI for CouchDB. To get it running in development on your machine.
Follow the steps below.
 
-## COUCHDB is required ##
+## CouchDB is Required
 
 Install couchdb from docs here: http://couchdb.readthedocs.org/en/latest/install/index.html
 
-## Setup Fauxton ##
+## Setup Fauxton
 
 A recent of [node.js](http://nodejs.org/) and npm is required.
 
-### FORK THIS REPO
+### Fork this Repo
 
-    1. Fork the THIS repo: https://github.com/apache/couchdb-fauxton.git
-    2. add upstream to the main git repo 'git remote add git-repo https://github.com/apache/couchdb-fauxton.git'
-    2. add upstream to the private apache repo 'git remote add upstream http://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git'
-    3. cd couchdb-fauxton
-    4. npm install
+1. Fork this repo: https://github.com/apache/couchdb-fauxton.git
+2. add upstream to the main git repo: `git remote add git-repo https://github.com/apache/couchdb-fauxton.git`
+3. add upstream to the private apache repo: `git remote add upstream http://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git`
+4. `cd couchdb-fauxton`
+5. `npm install`
 
 
 ### Install the grunt-cli
-In case you don't have the grunt command line interface installed, run the following command:
+In case you don't have the Grunt command line interface installed, run the following command:
 
     npm install -g grunt-cli
 
@@ -30,53 +30,68 @@ If you run into a permissions problem, run that last command as an administrator
     sudo npm install -g grunt-cli
 
 
-### NOTE: Before you run fauxton, don't forget to start couchdb!
+### NOTE: Before you run Fauxton, don't forget to start CouchDB!
 
 ### Dev Server
-Using the dev server is the easiest way to use fauxton, specially when
+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`
+You should be able to access Fauxton on `http://localhost:8000`
 
 ### Prepare Fauxton Release
-    Follow the "Fauxton Setup" section,
-    Edit settings.json variable root where the document will live.  eg.  "/_utils/fauxton/"
-
-    then:
+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`
+This will install the latest version of Fauxton into `/share/www/fauxton`
 
 ### Running Tests
-    There are two ways to run the tests. `grunt test` will run the tests via the commandline.
It is also possible to view them via the url
-    `http://localhost:8000/testrunner` when the dev server is running. Refreshing the url
will rerun the tests via phantomjs and in the browser.
+
+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 Fauxton
 
-    grunt couchapp_deploy - to deploy to your local [CouchDB instance] (http://localhost:5984/fauxton/_design/fauxton/index.html)
+To deploy to your local [CouchDB instance](http://localhost:5984/fauxton/_design/fauxton/index.html):
+
+    grunt couchapp_deploy
 
-## Understanding the Fauxton Code layout
+## Understanding the Fauxton Code Layout
 
-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](http://backbonejs.org/) and [Backbone.layoutmanager](https://github.com/tbranyen/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 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.
+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](http://backbonejs.org/)
and
+[Backbone.layoutmanager](https://github.com/tbranyen/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](writing_addons.md) for more information on writing your own
addons.
 
-## Todo items
+## Todo Items
 
-Checkout [Jira](https://issues.apache.org/jira/browse/COUCHDB/component/12320406) for a list
of items to do.
+Want to get involved? Check out [Jira](https://issues.apache.org/jira/browse/COUCHDB/component/12320406)
for a list
+of items to do.
 
 ## (Optional) To avoid a npm global install
     # Development mode, non minified files
     npm run couchdebug
 
     # Or fully compiled install
-    npm run couchdb
+    npm run couchdb
\ No newline at end of file


Mime
View raw message