Update instructions given the new ADDRESS requirement #118
Conversation
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
| @@ -107,8 +112,12 @@ cd crewlink-server | |||
| ```sh | |||
| yarn install | |||
| ``` | |||
| 3. Compile and run the project | |||
| ```JS | |||
| 3. Set the ADDRESS variable to your server URL | |||
There was a problem hiding this comment.
Where do you do this? What file? I am assuming .env but not everyone will know about such files
There was a problem hiding this comment.
In this case I was supposing you'd set it as a shell variable (see the example snippet, though I suppose that code snippet wouldn't work on Windows)... but maybe a .env file would be a better idea as it'd persist?
|
Hello @nathanparekh, I have submitted a patch (#119) to determine the ADDRESS automatically if one is not provided. Makes deployment to Heroku and many other situations easier. The documentation updates you have made here are very good - but if my patch is accepted the updates in this PR will need adjusting. Cheers, |
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.
Updates the readme to show in the instructions how to setup and use the newly required ADDRESS environment variable. As discussed in #116 there might be some better ways to handle this overall, but in the meantime the instructions should be updated so that people aren’t confused.
For quick reference: For Heroku, people currently need to deploy and then go to the app settings and set ADDRESS to their Heroku app url. For Docker, it needs to be set using -e or by modifying the Dockerfile. For Node, set manually.
Closes #117