couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From j..@apache.org
Subject [32/50] [abbrv] git commit: Add package.json for npm install and easier setup
Date Mon, 11 Feb 2013 11:12:14 GMT
Add package.json for npm install and easier setup

NOTE: I had to hardcode the bbb version as updating it broke a few
tasks. Will look into that later.


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

Branch: refs/heads/fauxton
Commit: f5060502755ceb845e1ab71e05e81fc55fbf71cb
Parents: 48ad061
Author: Russell Branca <chewbranca@gmail.com>
Authored: Wed Jan 30 17:54:23 2013 -0800
Committer: Russell Branca <chewbranca@gmail.com>
Committed: Wed Jan 30 17:54:23 2013 -0800

----------------------------------------------------------------------
 src/fauxton/package.json |   37 +++++++++++++++++++++++++++++++++++++
 src/fauxton/readme.md    |   39 +++++++++++++++++++++++----------------
 2 files changed, 60 insertions(+), 16 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/f5060502/src/fauxton/package.json
----------------------------------------------------------------------
diff --git a/src/fauxton/package.json b/src/fauxton/package.json
new file mode 100644
index 0000000..4c92787
--- /dev/null
+++ b/src/fauxton/package.json
@@ -0,0 +1,37 @@
+{
+  "name": "fauxton",
+  "version": "0.0.1",
+  "description": "Fauxton is a modular CouchDB dashboard and Futon replacement.",
+  "main": "grunt.js",
+  "directories": {
+    "test": "test"
+  },
+  "dependencies": {
+    "async": "~0.1.22",
+    "grunt": "~0.3.17",
+    "bbb": "0.1.10",
+    "grunt-contrib": "~0.0.8",
+    "grunt-contrib-copy": "~0.3.2",
+    "grunt-couchapp": "~0.1.0",
+    "grunt-exec": "~0.3.0",
+    "grunt-jasmine-task": "~0.2.0",
+    "underscore": "~1.4.2",
+    "url": "~0.7.9",
+    "urls": "~0.0.3"
+  },
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cloudant-labs/couchdb.git"
+  },
+  "keywords": [
+    "couchdb",
+    "futon",
+    "fauxton"
+  ],
+  "author": "",
+  "license": "Apache V2"
+}

http://git-wip-us.apache.org/repos/asf/couchdb/blob/f5060502/src/fauxton/readme.md
----------------------------------------------------------------------
diff --git a/src/fauxton/readme.md b/src/fauxton/readme.md
index 6d09c0d..5f351b9 100644
--- a/src/fauxton/readme.md
+++ b/src/fauxton/readme.md
@@ -16,33 +16,40 @@ Current items of interest:
 ## Setup ##
 
 Some recentish version of node.js and npm is required for the local
-development and build tools. You will will also need backbone boiler
-plate which will install the other dependencies needed.
+development and build tools.
+
+### CouchDB Setup ###
 
     git clone https://github.com/cloudant-labs/couchdb/ couchdb-fauxton
     cd couchdb-fauxton
     git checkout fauxton
     ./bootstrap && ./configure && make dev
+
+### Fauxton Setup ###
+
     cd src/fauxton
-    npm install -g bbb
-    npm install grunt-contrib-copy grunt-couchapp underscore couchapp grunt-exec async
-    bbb couchdb **or** bbb couchdebug
+
+    # Install all dependencies
+    npm install
+
+    # Add node_modules/.bin to your path
+    export PATH=./node_modules/.bin:$PATH
+
+    # Development mode, non minified files
+    bbb couchdebug
+
+    # Or fully compiled install
+    # bbb couchdb
+
+### Start CouchDB with Fauxton Installed ###
+
     ../../utils/run &
     open http://localhost:5984/_utils/fauxton/index.html
 
 ### Install as a Couchapp
-    git clone https://github.com/cloudant-labs/couchdb/ couchdb-fauxton
-    cd couchdb-fauxton
-    git checkout fauxton
-    cd src/fauxton
-    npm install -g bbb # install bbb globally
-    npm install grunt-contrib-copy grunt-couchapp underscore couchapp grunt-exec async
-    bbb couchapp_setup couchapp_install
 
-If you don't want bbb installed globally you can install it as a node module in
-the CWD:
+Complete the setup process as above and run:
 
-    npm install bbb grunt-contrib-copy grunt-couchapp underscore couchapp
-    node_modules/bbb/bin/bbb couchapp_setup couchapp_install
+    bbb couchapp_setup couchapp_install
 
 Install [phantomjs](http://phantomjs.org/) for tests.


Mime
View raw message