Return-Path: X-Original-To: apmail-couchdb-commits-archive@www.apache.org Delivered-To: apmail-couchdb-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id AE87511A97 for ; Mon, 21 Jul 2014 17:42:59 +0000 (UTC) Received: (qmail 665 invoked by uid 500); 21 Jul 2014 17:42:59 -0000 Delivered-To: apmail-couchdb-commits-archive@couchdb.apache.org Received: (qmail 617 invoked by uid 500); 21 Jul 2014 17:42:59 -0000 Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@couchdb.apache.org Delivered-To: mailing list commits@couchdb.apache.org Received: (qmail 608 invoked by uid 99); 21 Jul 2014 17:42:59 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 21 Jul 2014 17:42:59 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 2149D9AD7FD; Mon, 21 Jul 2014 17:42:59 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: deathbear@apache.org To: commits@couchdb.apache.org Message-Id: <2d91f2ad89204409a14dbb30f4be0988@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: fauxton commit: updated refs/heads/master to 6d74cfc Date: Mon, 21 Jul 2014 17:42:59 +0000 (UTC) Repository: couchdb-fauxton Updated Branches: refs/heads/master 37c7826c4 -> 6d74cfc86 Updated the readme for the new broken off repo Project: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/commit/6d74cfc8 Tree: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/tree/6d74cfc8 Diff: http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/diff/6d74cfc8 Branch: refs/heads/master Commit: 6d74cfc86fbfea0ccfeba8b60eb418a19170e592 Parents: 37c7826 Author: deathbearbrown Authored: Mon Jul 21 11:46:00 2014 -0400 Committer: deathbearbrown Committed: Mon Jul 21 13:42:51 2014 -0400 ---------------------------------------------------------------------- readme.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/blob/6d74cfc8/readme.md ---------------------------------------------------------------------- diff --git a/readme.md b/readme.md index df313c8..c6497d7 100644 --- a/readme.md +++ b/readme.md @@ -3,24 +3,24 @@ Fauxton Fauxton is the new Web UI for CouchDB. To get it running in development on your machine. Follow the steps below. -## Setup Fauxton ## +## COUCHDB is required ## -A recent of [node.js](http://nodejs.org/) and npm is required. +Install couchdb from docs here: http://couchdb.readthedocs.org/en/latest/install/index.html -### CouchDB Setup ### +## Setup Fauxton ## - 1. Clone the CouchDB repo: https://github.com/apache/couchdb.git or http://git-wip-us.apache.org/repos/asf/couchdb.git - cd couchdb +A recent of [node.js](http://nodejs.org/) and npm is required. -### Fauxton Setup ### +### FORK THIS REPO - # Clone the Fauxton repo: https://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git - git clone https://git-wip-us.apache.org/repos/asf/couchdb-fauxton.git fauxton + 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 - cd fauxton - # Install all dependencies - npm install +### 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 @@ -30,6 +30,9 @@ And then... grunt dev +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/"