couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gar...@apache.org
Subject fauxton commit: updated refs/heads/master to 8f1d8e5
Date Mon, 20 Feb 2017 10:44:10 GMT
Repository: couchdb-fauxton
Updated Branches:
  refs/heads/master 1b85d7b32 -> 8f1d8e509


Update CONTRIBUTING with quickstart instructions

These quickstart instructions would have helped me out a lot when I was getting started with
Fauxton. Think of it as a "TL;DR, I just want to start contributing now." :smiley:

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

Branch: refs/heads/master
Commit: 8f1d8e509873b3efd1c7786701e04ee9a25e7f83
Parents: 1b85d7b
Author: Nolan Lawson <nolan@nolanlawson.com>
Authored: Sat Feb 18 14:14:58 2017 -0800
Committer: Garren Smith <garren.smith@gmail.com>
Committed: Mon Feb 20 12:43:51 2017 +0200

----------------------------------------------------------------------
 CONTRIBUTING.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb-fauxton/blob/8f1d8e50/CONTRIBUTING.md
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 537a1b4..9d35579 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,6 +8,45 @@ with the framework you'd need to complete the task.
 
 The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information
about how to get the project running.
 
+## Contributor quick start
+
+Instructions to get a dev environment up and running as fast as possible:
+
+First, ensure that you have Node and npm installed. You should also have either CouchDB 2.0+
or PouchDB Server. The easiest to install is PouchDB Server:
+
+```
+npm install -g pouchdb-server
+pouchdb-server --port 5984
+```
+
+Now that we have a CouchDB (or PouchDB Server) up and running, check out the code:
+
+```
+git clone https://github.com/apache/couchdb-fauxton
+cd couchdb-fauxton
+npm install
+```
+
+Next, copy `settings.json.default.json` to `settings.json`. This will be our local settings
file.
+
+In the `settings.json`, under `"development"` -> `"app"`, change the `"host"` to point
to your local CouchDB or PouchDB Server, e.g.:
+
+```js
+"development": {
+  /* ... */
+  "app": {
+    /* ... */
+    "host": "http://localhost:5984"
+  }
+}
+```
+
+Now run:
+
+    npm run dev
+
+And your Fauxton dev server will be up and running at `localhost:8000`.
+
 ## Guide to Contributions
 
 We follow our coding-styleguide to make it easier for everyone to write, read and review
code: 


Mime
View raw message