blob: bb810956e906362e45b9651146eba7d2a0fe3d83 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
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. Copy or symlink the `settings.json.default` (or the
`settings.json.dev` file if you'd like to see the `styletests` addon).
And then...
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,
Edit settings.json variable root where the document will live. eg. "/_utils/fauxton/"
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.
|
