Skip to content

Commit

Permalink
Contributing docs for Windows
Browse files Browse the repository at this point in the history
  • Loading branch information
JeyRathnam committed Sep 21, 2023
1 parent bd37a5e commit 3ad5f73
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ HYPERDX_API_KEY=<YOUR_INGESTION_API_KEY_HERE> docker compose -f ./docker-compose
The core services are all hot-reloaded, so you can make changes to the code and
see them reflected in real-time.

### Windows

If you are running WSL 2, Hot module reload on Nextjs (Frontend) does not work out of the box on windows when run natively on docker. The fix here is to open project directory in WSL and run the above docker compose commands directly in WSL. Note that the project directory should not be under /mnt/c/ directory. You can clone the git repo in /home/{username} for example.

To develop from WSL, follow instructions [here](https://code.visualstudio.com/docs/remote/wsl).

## Additional support

If you need help getting started,
[join our Discord](https://discord.gg/FErRRKU78j) and we're more than happy to
get you set up!
get you set up!

0 comments on commit 3ad5f73

Please sign in to comment.