Skip to content

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

Closed

Description

@Warr1024

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions