Update CONTRIBUTING with quickstart instructions #855
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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." 😃
|
One remaining issue, though, is apparently you can't disable Content-Security-Policy in dev without changing |
garrensmith
reviewed
Feb 19, 2017
| npm install | ||
| ``` | ||
|
|
||
| Next, copy `settings.json.default.json` to `settings.json`. This will be our local settings file. |
There was a problem hiding this comment.
It will automatically read settings.json.default.json so you only need a settings.json if you have custom code.
garrensmith
requested changes
Feb 19, 2017
| /* ... */ | ||
| "app": { | ||
| /* ... */ | ||
| "host": "http://localhost:5984" |
There was a problem hiding this comment.
Weird. I thought it would default to this port. Is that not the case?
|
I thought I should specify, because some folks may have CouchDB 1.x already running on 5984, in which case they’d need to run PouchDB Server on something else. This was the case for me, for instance.
… On Feb 19, 2017, at 11:08 AM, garren smith ***@***.***> wrote:
@garrensmith requested changes on this pull request.
In CONTRIBUTING.md <#855 (comment)>:
> +```
+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"
Weird. I thought it would default to this port. Is that not the case?
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub <#855 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARUwjngrJkkfFukcYWH-X_UkoLYwPTOks5reJM_gaJpZM4MFRrV>.
|
|
+1 thanks. I've merged it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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." 😃