[couchdb-fauxton] branch master updated: Fix instructions on how to set up the dev server (#1216)

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acote pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-fauxton.git


The following commit(s) were added to refs/heads/master by this push:
     new 1e60fd8  Fix instructions on how to set up the dev server (#1216)
1e60fd8 is described below

commit 1e60fd8a820ecb148d79f29d96feebd7fa22bfc5
Author: Antonio Maranhao <30...@users.noreply.github.com>
AuthorDate: Tue Sep 17 16:01:52 2019 -0400

    Fix instructions on how to set up the dev server (#1216)
---
 CONTRIBUTING.md | 70 +++++----------------------------------------------------
 1 file changed, 5 insertions(+), 65 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3185375..1d6dd22 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -17,59 +17,7 @@ you want to help with the larger project. Come join us!
 If you never created a pull request before, welcome :tada: :smile: [Here is a great tutorial](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
 on how to send one :)
 
-The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information about how to get the project running.
-
-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`.
-
-Caveats:
-
-If the Fauxton UI appears to be held up loading data, check the
-browser dev tool error logs. If you see an error message like:
-
-```
-Refused to connect to '<URL>' because it violates the following Content Security Policy directive: "default-src 'self'". Note that 'connect-src' was not explicitly set, so 'default-src' is used as a fallback.
-```
-
-It means you need to enable CORS on CouchDB. There are a few ways of doing this:
-
-1. Directly in Fauxton through the Config panel (Gear icon on the side menu) under the CORS tab
-2. Use the [add-cors-to-couchdb](https://github.com/pouchdb/add-cors-to-couchdb) CLI
-3. Manually set it in CouchDB's [configuration files](https://docs.couchdb.org/en/1.3.0/cors.html#enabling-cors)
+The [Readme file](https://github.com/apache/couchdb-fauxton/blob/master/readme.md) has information about how to get the project set up for development.
 
 ## Guide to Contributions
 
@@ -80,17 +28,7 @@ To start working on a specific ticket, create a branch with the GitHub Issue # f
 
 > e.g. 1234-Added-support-for-list-functions
 
-If there is no GH Issue for the issue you have, you don't have to create one.
-
-Please describe the issue, how it happens and how you fixed it in the commit message. Before you submit the Pull
-Request, please run our testsuite and make sure that it passes:
-
-```
-grunt test
-```
-
-You can also open `couchdb-fauxton/test/runner.html` in a browser. Click on the headlines of the testcases to just run
-a specific test that fails - it should be faster than running the whole testsuite every time.
+If there is no GH Issue for the issue you have, you don't have to create one. Please describe the issue, how it happens and how you fixed it in the commit message.
 
 Commit messages should follow the following style:
 
@@ -105,7 +43,9 @@ Fixes #XXX (if there is a GH Issue)
 Fixes apache/couchdb#XXX (if there is a CouchDB project GH Issue)
 ```
 
-When you're ready for a review, submit a Pull Request. We regularly check the PR list for Fauxton and should get back
+Before you submit the Pull Request, please [run our test suite](#tests.md) and make sure that it passes.
+
+We regularly check the PR list for Fauxton and should get back
 to you with a code review. If no one has responded to you yet, you can find us on [Freenode IRC in #couchdb-dev][8].
 Ping **garren**, **robertkowalski** or **michellep** though anyone in the room should be able to help you.