diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 2214d8b39e..696bd18986 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -126,7 +126,16 @@ To run the budibase server and builder in dev mode (i.e. with live reloading): This will enable watch mode for both the builder app, server, client library and any component libraries. -### 5. Cleanup +### 5. Debugging using VS Code + +To debug the budibase server and worker a VS Code launch configuration has been provided. + +Visit the debug window and select `Budibase Server` or `Budibase Worker` to debug the respective component. +Alternatively to start both components simultaneously select `Start Budibase`. + +In addition to the above, the remaining budibase components may be ran in dev mode using: `yarn dev:noserver`. + +### 6. Cleanup If you wish to delete all the apps created in development and reset the environment then run the following: diff --git a/.vscode/launch.json b/.vscode/launch.json index 5025d14725..1587bfc537 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -21,6 +21,27 @@ "args": [], "cwd":"C:/code/my-apps", "console": "externalTerminal" + }, + { + "name": "Budibase Server", + "type": "node", + "request": "launch", + "runtimeArgs": ["--nolazy", "-r", "ts-node/register/transpile-only"], + "args": ["${workspaceFolder}/packages/server/src/index.ts"], + "cwd": "${workspaceFolder}/packages/server" + }, + { + "name": "Budibase Worker", + "type": "node", + "request": "launch", + "program": "${workspaceFolder}/packages/worker/src/index.js", + "cwd": "${workspaceFolder}/packages/worker" + } + ], + "compounds": [ + { + "name": "Start Budibase", + "configurations": ["Budibase Server", "Budibase Worker"] } ] } \ No newline at end of file