Reactjs.org: Add minimum required Node version to create-react-app docs

Created on 8 Oct 2017  路  16Comments  路  Source: reactjs/reactjs.org

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

Text of original issue

Please list [You鈥檒l 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

beginner good first issue in-progress documentation

Most helpful comment

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.

All 16 comments

I will work on this issue.

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!

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

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

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

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"

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

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.

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

Closed via #89

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/

@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!)

@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~

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

@bvaughn
Thank you, Brian.

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

Cool. Thanks!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

VinayakBagaria picture VinayakBagaria  路  3Comments

jaredp picture jaredp  路  4Comments

chochihim picture chochihim  路  3Comments

ahtee picture ahtee  路  4Comments

gajomon picture gajomon  路  4Comments