Some corrections and an additions#15
Open
AndreasAusKiel wants to merge 1 commit intoHuman-Connection:masterfrom
Open
Some corrections and an additions#15AndreasAusKiel wants to merge 1 commit intoHuman-Connection:masterfrom
AndreasAusKiel wants to merge 1 commit intoHuman-Connection:masterfrom
Conversation
Setup the API via Docker: Added, that the Server is running after the first sudo docker-compose up --build and rewrote the following information for a better "flowing" readability. Setting up the database seeder for local development: Corrected the path from config/docker/* to config/*, and optimized the following sentence a bit.
roschaefer
reviewed
Nov 16, 2018
| . | ||
|
|
||
| Now, your API should be running at [http://localhost:3030](http://localhost:3030) and you can see some contributions at [http://localhost:3030/contributions](http://localhost:3030/contributions). | ||
| . You see no more changes in your terminal-window? |
Contributor
There was a problem hiding this comment.
Suggested change
| . You see no more changes in your terminal-window? | |
| . This may take a while, depending on your hardware and your internet connection. |
roschaefer
reviewed
Nov 16, 2018
|
|
||
| Now, your API should be running at [http://localhost:3030](http://localhost:3030) and you can see some contributions at [http://localhost:3030/contributions](http://localhost:3030/contributions). | ||
| . You see no more changes in your terminal-window? | ||
| Congratulations: Your server is now running at [http://localhost:3030](http://localhost:3030) which you can load in your browser. Some contributions wait for you at [http://localhost:3030/contributions](http://localhost:3030/contributions). |
Contributor
There was a problem hiding this comment.
Suggested change
| Congratulations: Your server is now running at [http://localhost:3030](http://localhost:3030) which you can load in your browser. Some contributions wait for you at [http://localhost:3030/contributions](http://localhost:3030/contributions). | |
| After a while, your server is running at [http://localhost:3030](http://localhost:3030) which you can load in your browser. Some contributions wait for you at [http://localhost:3030/contributions](http://localhost:3030/contributions). |
roschaefer
reviewed
Nov 16, 2018
| Change the configuration in `config/local-development.json` or `config/local.json` and rerun `docker-compose up --build`. | ||
|
|
||
| If both the files do no exist create a `config/local.json` and copy the content of `config/local.example.json` and rerun `docker-compose up --build`. | ||
| If both files do no exist, create a `config/local.json` , copy the content of `config/local.example.json` into it and rerun `docker-compose up --build`. |
Contributor
There was a problem hiding this comment.
Suggested change
| If both files do no exist, create a `config/local.json` , copy the content of `config/local.example.json` into it and rerun `docker-compose up --build`. | |
| If both files do not exist, run `cp config/local.example.json config/local.json` and rerun `docker-compose up --build`. | |
| You can learn more about the purpose of these configuration files and the order how they are loaded in the wiki of `node-config`: |
roschaefer
requested changes
Nov 16, 2018
Contributor
roschaefer
left a comment
roschaefer
left a comment
There was a problem hiding this comment.
@AndreasAusKiel thanks! Here are some suggestions how to improve the docs. Code is usually better than text (it's easier to copy+paste 😉)
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Setup the API via Docker:
Added, that the Server is running after the first sudo docker-compose up --build and rewrote the following information for a better "flowing" readability.
Setting up the database seeder for local development:
Corrected the path from config/docker/* to config/*, and optimized the following sentence a bit.