2025-01-07 16:16:17 -08:00
|
|
|
# VSCode Debugging Setup
|
|
|
|
|
|
|
|
|
|
This guide explains how to set up and use VSCode's debugging capabilities with this project.
|
|
|
|
|
|
|
|
|
|
## Initial Setup
|
|
|
|
|
|
|
|
|
|
1. **Environment Setup**:
|
|
|
|
|
- Copy `.vscode/.env.template` to `.vscode/.env`
|
|
|
|
|
- Fill in the necessary environment variables in `.vscode/.env`
|
2025-01-07 16:18:46 -08:00
|
|
|
2. **launch.json**:
|
|
|
|
|
- Copy `.vscode/launch.template.jsonc` to `.vscode/launch.json`
|
2025-01-07 16:16:17 -08:00
|
|
|
|
|
|
|
|
## Using the Debugger
|
|
|
|
|
|
|
|
|
|
Before starting, make sure the Docker Daemon is running.
|
|
|
|
|
|
|
|
|
|
1. Open the Debug view in VSCode (Cmd+Shift+D on macOS)
|
|
|
|
|
2. From the dropdown at the top, select "Clear and Restart External Volumes and Containers" and press the green play button
|
|
|
|
|
3. From the dropdown at the top, select "Run All Onyx Services" and press the green play button
|
2025-01-17 14:50:22 -05:00
|
|
|
4. CD into web, run "npm i" followed by npm run dev.
|
|
|
|
|
5. Now, you can navigate to onyx in your browser (default is http://localhost:3000) and start using the app
|
|
|
|
|
6. You can set breakpoints by clicking to the left of line numbers to help debug while the app is running
|
|
|
|
|
7. Use the debug toolbar to step through code, inspect variables, etc.
|
2025-01-07 16:16:17 -08:00
|
|
|
|
|
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
- Hot reload is enabled for the web server and API servers
|
|
|
|
|
- Python debugging is configured with debugpy
|
|
|
|
|
- Environment variables are loaded from `.vscode/.env`
|
|
|
|
|
- Console output is organized in the integrated terminal with labeled tabs
|
