You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ru...@apache.org on 2023/04/07 22:19:23 UTC

[superset] branch master updated: docs(contributing): add local vscode config for backend debugging (#19733)

This is an automated email from the ASF dual-hosted git repository.

rusackas pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/master by this push:
     new c5f93686d8 docs(contributing): add local vscode config for backend debugging (#19733)
c5f93686d8 is described below

commit c5f93686d8ded4e3c320090e50bc1fab50eefc15
Author: Cemre Mengu <ce...@gmail.com>
AuthorDate: Sat Apr 8 01:19:15 2023 +0300

    docs(contributing): add local vscode config for backend debugging (#19733)
---
 CONTRIBUTING.md | 35 ++++++++++++++++++++++++++++++++++-
 1 file changed, 34 insertions(+), 1 deletion(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c8f72d2b22..b5d42fb195 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -893,6 +893,39 @@ npm run cypress open
 
 ### Debugging Server App
 
+#### Local
+
+For debugging locally using VSCode, you can configure a launch configuration file .vscode/launch.json such as
+
+```json
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python: Flask",
+            "type": "python",
+            "request": "launch",
+            "module": "flask",
+            "env": {
+                "FLASK_APP": "superset",
+                "FLASK_ENV": "development"
+            },
+            "args": [
+                "run",
+                "-p 8088",
+                "--with-threads",
+                "--reload",
+                "--debugger"
+            ],
+            "jinja": true,
+            "justMyCode": true
+        }
+    ]
+}
+```
+
+#### Docker
+
 Follow these instructions to debug the Flask app running inside a docker container.
 
 First add the following to the ./docker-compose.yaml file
@@ -970,7 +1003,7 @@ tcp        0      0 0.0.0.0:8088            0.0.0.0:*               LISTEN
 
 You are now ready to attach a debugger to the process. Using VSCode you can configure a launch configuration file .vscode/launch.json like so.
 
-```
+```json
 {
     "version": "0.2.0",
     "configurations": [