Task: Add 'How to debug' section to the README file.

[egillanton]

Task

Add documentation on how to debug the app locally.

Add for example a .vscode/launch.json file that people can use to run the app instead of running npm run dev.

For now, there is no way for a newcomer to debug their code.

[egillanton]

In a Shopify CLI 1.X and 2.X generated app I was able to create easily a .vscode/launch.json file that I would use when debugging locally:

.vscode/launch.json

 {
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Launch Program",
      "skipFiles": [
        "<node_internals>/**"
      ],
      "program": "${workspaceFolder}\\server\\index.js"
    }
  ]
}

[Michael-Gibbons]

I agree, putting it in the repo would be too opinionated imo but I like the idea of adding it to the readme! I will look into this.

[github-actions]

This issue is stale because it has been open for 60 days with no activity. It will be closed if no further action occurs in 14 days.

[yinxiangming]

I think you can debug from package.json. Open it from VS code exporlor and click the "debug" link after a triangle. It will popup a menu to let you select the commands in package.json. Select the "dev", then it will run the "shopify app dev" command and attach the debugger.