Skip to content

feat: troubleshooting local develompent environment tips #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: troubleshooting local develompent environment tips #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions contributing/tips_and_tricks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ _{remote-name} is whatever you want to call the remote repo - eg, "coworker-repo
2. Run `git branch -a` - you should now be able to see the branches of their remote repo, in addition to the ones from "origin" (which will be your fork of the WST repo)
3. Run `git checkout -b {fork-name} {remote-name}/{fork-name}`

# Troubleshooting local development environment

- If `docker compose up` freezes at `environment | == Preparing database ==` (and maybe logs `database exited with code 137`), your Docker daemon (Docker Desktop, Rancher Desktop, Colima etc.) likely has too little RAM allocated to it. Try giving it 4GB.
- If HMR in React (shakapacker, not Next.js) isn't working, you see `[HMR] Waiting for update signal from WDS...` in the browser console, and you are using Rancher Desktop on MacOS, the issue is likely webpack not picking up on file changes in the mounted `.:/app` volume. To confirm this, check if editing a CSS file directly inside the container (see `docker exec`) triggers HMR. If this is the case, switching from Rancher Desktop to Colima might help.