chore: enable debugging #196
Merged
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
LoneRifle
force-pushed
the
debugging
branch
2 times, most recently
from
f6a86c3 to
f9ca9f9
Compare
To allow developers to quickly troubleshoot the codebase, configure GoGovSG to run with debugging enabled, even when in a docker container. [npm, docker] - replace nodemon and ts-node with ts-node-dev - expose port 9229 (Node.js debug) for app container in docker-compose - `npm run server-dev` listen for port 9229 on all interfaces, not just localhost, to facilitate debugging within a Docker container [1] [docs] - rewrite the README to document ts-node-dev instead of nodemon [gitpod] - ignore port 9229 - add Theia launch config to attach a debugger to `npm run docker-dev` [misc] - remove nodemon.json, no longer used - allow favicons to be served directly by webpack-dev-server Notes: [1] - This is needed as Docker would treat its host as a separate machine. This also means that debugging on bare-metal would allow others to connect to the port remotely. Caution is hence advised when choosing to debug GoGovSG on bare-metal
liangyuanruo
approved these changes
Jun 17, 2020
|
@liangyuanruo it's basically the VSCode fork maintained by the Eclipse Foundation that Gitpod builds on top of |
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.
Problem
To allow developers to quickly troubleshoot the codebase, configure
GoGovSG to run with debugging enabled, even when in a docker container.
Solution
[npm, docker]
npm run server-devlisten for port 9229 on all interfaces, not justlocalhost, to facilitate debugging within a Docker container [1]
[docs]
[gitpod]
npm run docker-dev[misc]
Notes
[1] - This is needed as Docker would treat its host as a separate
machine. This also means that debugging on bare-metal would allow
others to connect to the port remotely. Caution is hence advised when
choosing to debug GoGovSG on bare-metal