Skip to content
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.

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

Documentation: Unclear/misleading URL open in yarn dev process #432

Closed
Warr1024 opened this issue Sep 11, 2022 · 0 comments
Closed

Documentation: Unclear/misleading URL open in yarn dev process #432

Warr1024 opened this issue Sep 11, 2022 · 0 comments

Comments

@Warr1024
Copy link
Contributor

Describe the bug

https://github.com/butlerx/wetty/blob/main/docs/development.md does not make it clear what URL to open to access the locally-running server, and the yarn dev script actually attempts to xdg-open http://localhost:8080/ (some built-in default?) which is incorrect and confusing.

To Reproduce
Steps to reproduce the behavior:

  1. Check out git src.
  2. yarn
  3. yarn build
  4. yarn dev

Expected behavior
Once WeTTY is running locally, any one of the following happens:

  • the web UI is opened for me automatically by script, or
  • I follow clear and correct instructions on how to open it, either output by the script, or in the development.md docs.

Actual behavior

Additional context
Luckily I was able to figure out what I'm supposed to be doing was by parsing the [1] info: Starting server {"base":"/wetty/","label":"Wetty","port":3000,... log line, but it would be far better if new prospective devs faced fewer obstacles getting started.

butlerx added a commit that referenced this issue Oct 9, 2022
close issue #432

- use `snowpack build --watch` rather then `snowpack dev`
- Update `docs/developments.md` to reflect the acutal development
  environment
@butlerx butlerx closed this as completed Oct 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants