Update docs to use docker compose commands #100
Merged
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
talyssonoc
reviewed
May 12, 2022
It's necessary to run yarn remote localhost 2580
I'm added Docker installation page if someaone wants to use it, i change the commands yarn start, yarn dev, yarn debug to the respective docker-compose commands and separate running commands for "With Docker" and "Locally", in "Locally" i left it as it was. update docs
VictorAugDB
force-pushed
the
update-docs-to-use-docker-compose-commands
branch
from
2a3b49a to
41f888f
Compare
Remove the build script from this branch an use the build come from the origin main
brunohcastro
reviewed
Jun 1, 2022
docker-compose.debug.yaml
Outdated
| @@ -0,0 +1,3 @@ | |||
| services: | |||
| api: | |||
| command: bash -c "yarn install && yarn debug" No newline at end of file | |||
Collaborator
There was a problem hiding this comment.
If using the debug command, we should also expose the remote debug port, by default it's 9229. What do you think?
Contributor
Author
There was a problem hiding this comment.
Ok i configured the debug to docker.
See the commit here: e9a05b1
Contributor
Author
There was a problem hiding this comment.
And configured to run locally.
See the commit here: 5b5c626
Config debug on .vscode to run in attach mode on port 9229, modify .gitignore to not ignore this file. On the package.json add explicity what port the debug need to run and add --nolazy flag reason: https://stackoverflow.com/questions/21534565/what-does-the-node-js-nolazy-flag-mean Expose the debug port only if docker-compose-debug.yaml file is runned. Add inlineSourceMap flag to tsconfig.json reference: https://www.typescriptlang.org/tsconfig#inlineSourceMap
brunohcastro
approved these changes
Jun 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Description
I updated the docs describing how to run the application with Docker and I left as Locally the previous instructions.
I also expose socket port to run remote
Why
It's a good thing to describe because there are those who didn't want to install the dependencies locally