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

Add minimum required Node version to create-react-app docs #70

Closed
bvaughn opened this issue Oct 8, 2017 · 16 comments
Closed

Add minimum required Node version to create-react-app docs #70

bvaughn opened this issue Oct 8, 2017 · 16 comments

Comments

@bvaughn
Copy link
Contributor

bvaughn commented Oct 8, 2017

This issue was originally reported by @kyamaguchi81 via facebook/react/issues/10324

Text of original issue

Please list [You’ll need to have Node >= 6 on your machine.]
before the description in [npm install -g create-react-app],
In [Creating a New Application] of the document https://facebook.github.io/react/docs/installation.html.

Because you want to know the required version before running the command

@dance2die
Copy link
Contributor

I will work on this issue.

@bvaughn
Copy link
Contributor Author

bvaughn commented Oct 8, 2017

This issue is all yours! 😄

I've added an "in-progress" label so that others will know not to start work on the issue. If you change your mind about the issue, no worries! Just let me know so that I can remove the label and free it up for someone else to claim.

Cheers!

@dance2die
Copy link
Contributor

Thank you @bvaughn
Struggling to set up the environment but it's part of the fun~

@bvaughn
Copy link
Contributor Author

bvaughn commented Oct 8, 2017

Please feel free to leave feedback about where you struggled in case it helps us improve the contributing docs.

@dance2die
Copy link
Contributor

dance2die commented Oct 8, 2017

I will create an issue and work on it later on (regarding node-gyp failing to build on Windows)

@dance2die
Copy link
Contributor

dance2die commented Oct 8, 2017

Hi @bvaughn Below is the feedback 👍 with struggles I had today.

I was finally able to get it up and running but had a lot of trouble on Windows.

Below are the steps required to get the environment running on Windows 10.

  1. Get node-gyp working using this documentation on nodejs/node-gyp.
  2. Installed following commands globally
yarn global add prettier
yarn global add flow-bin
  1. yarn check-all fails to execute on windows.

image

So I had to run each command separately one by one.

prettier --config .prettierrc --write "{flow-typed,plugins,src}/**/*.js"
yarn lint
yarn flow

yarn check-all failed because of the single quotes used in the prettier command.
Instead of
prettier --config .prettierrc --write '{flow-typed,plugins,src}/**/*.js'
I had used double quotes around {flow-typed,plugins,src}/**/*.js
prettier --config .prettierrc --write "{flow-typed,plugins,src}/**/*.js"

@swyxio
Copy link
Contributor

swyxio commented Oct 8, 2017

i def think Windows setup is something that should be part of the docs for contributors. too easy for devs to just assume everyone has macs

@bvaughn
Copy link
Contributor Author

bvaughn commented Oct 9, 2017

i def think Windows setup is something that should be part of the docs for contributors. too easy for devs to just assume everyone has macs

There were no such assumptions. I just have a Mac myself and I wrote the docs so...I wrote what I know. We certainly welcome contributions to the contributing docs to improve the instructions for Windows users! ❤️

If you'd be willing to commit the changes you needed to make via a PR, @dance2die, and tag me on it- I'd be happy to merge it.

@dance2die
Copy link
Contributor

Thank you @bvaughn
I will add a tag you and add the link to your comment in PR comment.

bvaughn added a commit that referenced this issue Oct 9, 2017
Add minimum required Node version to create-react-app docs #70
@bvaughn
Copy link
Contributor Author

bvaughn commented Oct 9, 2017

Closed via #89

@bvaughn bvaughn closed this as completed Oct 9, 2017
@dance2die
Copy link
Contributor

I've created a detailed blog entry on how to setup the environment on Windows 10.
https://www.slightedgecoder.com/2017/10/15/setting-reactjs-org-environment-open-source-contribution/

@bvaughn
Copy link
Contributor Author

bvaughn commented Oct 16, 2017

@dance2die Your write-up says:

Now install following two NPM packages globally.

yarn global add prettier
yarn global add flow-bin

Why is this necessary? Both prettier and flow-bin are declared as project dependencies in package.json and so should be installed within the project.

Also, you should be able to update the "Problem2" section now since your PR has been merged. (Thanks!)

@dance2die
Copy link
Contributor

dance2die commented Oct 16, 2017

@bvaughn

Now install following two NPM packages globally.

Why is this necessary?

You are right. I just tried it after globally removing prettier & flow-bin.
Both commands were not found for some reason on computer at home but works fine on different machine.

Thank you, Brian. I will update the blog~

@bvaughn
Copy link
Contributor Author

bvaughn commented Oct 16, 2017

Sweet! Ping me once it's updated and I'll tweet a link to it.

@dance2die
Copy link
Contributor

dance2die commented Oct 16, 2017

@bvaughn
Thank you, Brian.

I've updated the blog and renamed Problem 2 -... to "Verify that the site works".

@bvaughn
Copy link
Contributor Author

bvaughn commented Oct 16, 2017

Cool. Thanks!

OhIAmFine pushed a commit to OhIAmFine/zh-hans.reactjs.org that referenced this issue May 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants