diff options
| author | Ryan Ramage <ryan.ramage@gmail.com> | 2013-03-18 20:29:23 -0600 |
|---|---|---|
| committer | Ryan Ramage <ryan.ramage@gmail.com> | 2013-03-18 20:29:23 -0600 |
| commit | 10cf9c5f9eb151923a1c9ec9d623b4ffe3ff9c95 (patch) | |
| tree | dee5981d725cee23d0f556cda095f360b0a6fe32 | |
| parent | 35a699e6e6e61339d59f2456ea10017d072928a3 (diff) | |
| download | couchdb-10cf9c5f9eb151923a1c9ec9d623b4ffe3ff9c95.tar.gz | |
Adding build status badge
| -rw-r--r-- | src/fauxton/readme.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/src/fauxton/readme.md b/src/fauxton/readme.md index 409296f09..0cc24c8e7 100644 --- a/src/fauxton/readme.md +++ b/src/fauxton/readme.md @@ -5,6 +5,9 @@ This is the initial implementation of Fauxton, focused on fleshing out the various pieces of functionality and as a test bed for new ideas. Full functionality and design considerations will be added later. + +[](http://ci.couchdb.org:8888/job/Fauxton/) + Current items of interest: * Live JSON editor with dynamic JS Hinting and error popups @@ -29,7 +32,7 @@ A recent of [node.js](http://nodejs.org/) and npm is required. # 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 @@ -53,12 +56,12 @@ A recent of [node.js](http://nodejs.org/) and npm is required. ## Understang Fauxton Code layout 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, +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. ## Todo items -Checkout [Jira](https://issues.apache.org/jira/browse/COUCHDB/component/12320406) for a list of items to do. +Checkout [Jira](https://issues.apache.org/jira/browse/COUCHDB/component/12320406) for a list of items to do. |