https://github.com/hydroshare/vscode

Git Submodule for vscode debug of hydroshare Docker containers
https://github.com/hydroshare/vscode

Last synced: about 1 month ago
JSON representation

Git Submodule for vscode debug of hydroshare Docker containers

• Host: GitHub
• URL: https://github.com/hydroshare/vscode
• Owner: hydroshare
• Created: 2022-02-11T14:53:31.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-03-10T23:16:34.000Z (over 1 year ago)
• Last Synced: 2025-03-11T00:23:26.654Z (over 1 year ago)
• Language: Shell
• Size: 50.8 KB
• Stars: 0
• Watchers: 10
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# vscode hydroshare debug

Repo for vscode debug of Hydroshare Docker containers

## Instructions to use

1. You must first clone [Hydroshare](https://github.com/hydroshare/hydroshare) if you haven't

2. Run [local-dev-first-start-only](https://github.com/hydroshare/hydroshare/blob/develop/local-dev-first-start-only.sh) if you haven't. No need to do the `docker-compose up`, we will modify that step so that it uses a custom .yml file

3. cd into your new hydroshare dir and clone this repo: `git clone git@github.com:hydroshare/vscode.git .vscode` NOTE: yes, that `.vscode` is supposed to be a hidden dir. See https://code.visualstudio.com/docs/editor/debugging#_launch-configurations.

4. run `.vscode/configure-vscode-debug.sh` to create a required init-hydroshare-debug and **remove your hydroshare container** <<< YES, it will remove your container!

6. run `docker-compose -p hydroshare -f .vscode/docker-compose.debug.yml up` to build the new container and bring it up

7. use vscode "run and debug" module to connect to the container and start debugging![image](https://user-images.githubusercontent.com/17934193/208769548-051c49d0-52e1-40f6-968b-ca863a1b385f.png)

9. Add breakpoints in vs-code

10. Browser-> navigate to localhost:8000 and trigger your breakpoints

## submodule

You can run this as a git submodule too but I don't think we want to checkin any of the submodule info into the hydroshare repo

So if you do this, just make sure you don't commit the added files to [Hydroshare](https://github.com/hydroshare/hydroshare)

From your project root:

- `git submodule add -f git@github.com:hydroshare/vscode.git .vscode`

- `git submodule update --remote .vscode`

- then follow all of the above instructions to use