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

Issue example requires yarn #116

Open
handeyeco opened this issue Nov 6, 2019 · 1 comment
Open

Issue example requires yarn #116

handeyeco opened this issue Nov 6, 2019 · 1 comment

Comments

@handeyeco
Copy link

Just thought I'd point out something that might be confusing to some.

In the README for the Issue example, there are instructions for both npm and yarn users:

    # npm users:
    npm start

    # yarn users:
    yarn start

When I went through the instructions without having yarn installed, I got an error:

$ npm start

> yarn run relay; concurrently --kill-others --names "react-scripts,relay" "react-scripts start" "yarn run relay --watch"

sh: yarn: command not found
[relay] /bin/sh: yarn: command not found
[relay] yarn run relay --watch exited with code 127

My point is, if yarn is required and yarn is not included as a dev dependency should the README include npm instructions at all?

Would recommend either:

  • Removing npm examples from the README
  • Adding yarn as a dev dependency
@kassens
Copy link
Contributor

kassens commented Nov 6, 2019

I think yarn run can be safely replaced with npm run here (if someone uses yarn, I think yarn automatically replaces npm with yarn for these scripts)

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