Improve DEV-LOCAL.md with prerequisites, verification steps, and troubleshooting#2273
Conversation
…s, and troubleshooting
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9c4d5a4d25
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
DEV-LOCAL.md
Outdated
| ```bash | ||
| make -C packages/client-proxy run-local | ||
| ``` | ||
| Verify: `curl -s http://localhost:3002/health` returns a response. |
There was a problem hiding this comment.
Point client-proxy health check to the health listener
The verification step uses http://localhost:3002/health, but run-local starts client-proxy with default ports where ProxyPort is 3002 and HealthPort is 3003 (packages/client-proxy/internal/cfg/model.go), and main.go binds the health server to HealthPort. In a normal local setup this check can fail even when the service is healthy, which makes the guide report a false negative for a working client-proxy instance.
Useful? React with 👍 / 👎.
Co-authored-by: Jakub Novák <kubus.novak@gmail.com>
Summary
Improves the local development guide (
DEV-LOCAL.md) to make it easier for new contributors and self-hosters to get a working local environment..env.localfiles and their purposeCloses #2211 (partial — covers the local dev documentation portion).