From 86e4920ee0a868ca49331f7357b13c94bf999a63 Mon Sep 17 00:00:00 2001 From: Tim Hansen Date: Thu, 8 Jul 2021 12:42:00 -0600 Subject: [PATCH 1/2] Add debugging instructions to backend README Signed-off-by: Tim Hansen --- packages/backend/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/packages/backend/README.md b/packages/backend/README.md index 97890f72cb..cccd84afb8 100644 --- a/packages/backend/README.md +++ b/packages/backend/README.md @@ -39,6 +39,21 @@ You can also, instead of using dummy values for a huge number of environment var The backend starts up on port 7000 per default. +### Debugging + +The backend is a node process that can be inspected to allow breakpoints and live debugging. To enable this, pass the `--inspect` flag to [backend:dev](https://backstage.io/docs/cli/commands#backenddev). + +To debug the backend in [Visual Studio Code](https://code.visualstudio.com/): + +- Enable Auto Attach (⌘ + Shift + P > Toggle Auto Attach > Only With Flag) +- Open a VSCode terminal (Control + `) +- Run the backend from the VSCode terminal: + +``` +$ cd packages/backend +$ yarn backstage-cli backend:dev --inspect +``` + ## Populating The Catalog If you want to use the catalog functionality, you need to add so called From 9d38188c2b12bf097ad4c8f3da5b3ff8fe234bfa Mon Sep 17 00:00:00 2001 From: Tim Hansen Date: Thu, 8 Jul 2021 15:17:57 -0600 Subject: [PATCH 2/2] start-backend Signed-off-by: Tim Hansen --- packages/backend/README.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/packages/backend/README.md b/packages/backend/README.md index cccd84afb8..e6f0c899ca 100644 --- a/packages/backend/README.md +++ b/packages/backend/README.md @@ -47,12 +47,7 @@ To debug the backend in [Visual Studio Code](https://code.visualstudio.com/): - Enable Auto Attach (⌘ + Shift + P > Toggle Auto Attach > Only With Flag) - Open a VSCode terminal (Control + `) -- Run the backend from the VSCode terminal: - -``` -$ cd packages/backend -$ yarn backstage-cli backend:dev --inspect -``` +- Run the backend from the VSCode terminal: `yarn start-backend --inspect` ## Populating The Catalog