Updated Branches: refs/heads/1964-feature-fauxton-build [created] 0ac0faa14
Moved Fauxton README to DEVELOPERS Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/0ac0faa1 Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/0ac0faa1 Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/0ac0faa1 Branch: refs/heads/1964-feature-fauxton-build Commit: 0ac0faa14bfaf885cc1bdfcc7c1b970cd0e358ed Parents: 5e2a427 Author: Noah Slater <[email protected]> Authored: Sat Dec 14 12:33:29 2013 +0100 Committer: Noah Slater <[email protected]> Committed: Sat Dec 14 12:33:29 2013 +0100 ---------------------------------------------------------------------- DEVELOPERS | 99 ++++++++++++++++++++++++++++++++++++++++++++++ src/fauxton/readme.md | 76 ----------------------------------- 2 files changed, 99 insertions(+), 76 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/0ac0faa1/DEVELOPERS ---------------------------------------------------------------------- diff --git a/DEVELOPERS b/DEVELOPERS index e6ea141..44eeae7 100644 --- a/DEVELOPERS +++ b/DEVELOPERS @@ -118,6 +118,105 @@ Windows Follow the instructions in INSTALL.Windows and build all components from source, using the same Visual C++ compiler and runtime. +Fauxton +------- + +Temporary documentation, to be integrated properly later. + +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. + +Current items of interest: + + * Live JSON editor with dynamic JS Hinting and error popups + * Initial plugin system + * Minimal externally loadable plugin example + * Data popups for additional db info on \_all_dbs page + * CouchDB API compliant urls + +A recent of [node.js](http://nodejs.org/) and npm is required. + +Fauxton Setup +~~~~~~~~~~~~~ + +cd src/fauxton + +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/ + +Development mode, non minified files +./bin/grunt couchdebug + +Or fully compiled install +/bin/grunt couchdb + +Dev Server +~~~~~~~~~~ + +Using the dev server is the easiest way to use fauxton, specially when +developing for it. + +grunt dev + +Prepare Fauxton Release +~~~~~~~~~~~~~~~~~~~~~~~ + +Follow the "Fauxton Setup" section then: + +./bin/grunt couchdb + +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. + +To Deploy Fauxton +~~~~~~~~~~~~~~~~~ + +./bin/grunt couchapp_deploy - to deploy to your local [Couchdb instance] +(http://localhost:5984/fauxton/_design/fauxton/index.html) + +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, `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. + Bootstrapping ------------- http://git-wip-us.apache.org/repos/asf/couchdb/blob/0ac0faa1/src/fauxton/readme.md ---------------------------------------------------------------------- diff --git a/src/fauxton/readme.md b/src/fauxton/readme.md deleted file mode 100644 index 1cc59ab..0000000 --- a/src/fauxton/readme.md +++ /dev/null @@ -1,76 +0,0 @@ -Fauxton -======= - -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. - - - -Current items of interest: - - * Live JSON editor with dynamic JS Hinting and error popups - * Initial plugin system - * Minimal externally loadable plugin example - * Data popups for additional db info on \_all_dbs page - * CouchDB API compliant urls - -## Setup Fauxton ## - -A recent of [node.js](http://nodejs.org/) and npm is required. - -### CouchDB Setup ### - - 1. Clone the Couchdb repo: https://github.com/apache/couchdb.git or http://git-wip-us.apache.org/repos/asf/couchdb.git - cd couchdb - -### Fauxton Setup ### - - cd src/fauxton - - # Install all dependencies - npm install - -### Dev Server - Using the dev server is the easiest way to use fauxton, specially when developing for it. - - grunt dev - -#### (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/ - - # Development mode, non minified files - ./bin/grunt couchdebug - - # Or fully compiled install - # ./bin/grunt couchdb - -### Prepare Fauxton Release - Follow the "Fauxton Setup" section then: - - ./bin/grunt couchdb - - 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. - -### To Deploy Fauxton - - ./bin/grunt couchapp_deploy - to deploy to your local [Couchdb instance] (http://localhost:5984/fauxton/_design/fauxton/index.html) - -## 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, -`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. -
