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.

Sign up for GitHub

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 instructions on alternative methods of app creation #4638

Merged
merged 7 commits into from
Jun 20, 2018
Merged

Add instructions on alternative methods of app creation #4638

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
47a359d
Add instructions on alternative methods of app creation
RusinovAnton Jun 18, 2018
701bc6f
Clear up unnecessities
RusinovAnton Jun 18, 2018
0388fb7
whitespace
RusinovAnton Jun 18, 2018
153ec3a
whitespace
RusinovAnton Jun 18, 2018
f8f993a
whitespace
RusinovAnton Jun 18, 2018
0ac7e37
clear up
RusinovAnton Jun 18, 2018
bb4f62f
Check phrasing
RusinovAnton Jun 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,29 @@ Just create a project, and you’re good to go.

**You’ll need to have Node >= 6 on your local development machine** (but it’s not required on the server). You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to easily switch Node versions between different projects.

To create a new app, run a single command:
To create a new app, you may choose one of the following methods:

### npx
```sh
npx create-react-app my-app
```

*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))*

### npm init

Since npm of 6+ `npm init <name> <...args>` command may be used as an alias for `npx create-<name> <...args>`:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some of this information is unnecessary, can we make it more in line with the npx header?

npm

npm init react-app my-app

(npm init comes with npm 6+ and higher, see instructions for older npm versions)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we even need this section if they have npm 5+?

Should we only recommend npx since it's available in both npm 5/6?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense to recommend it as an alternative as long as we're clear that it's only available in npm 6+.

```sh
npm init react-app my-app
```

### yarn create
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please capitalize Yarn and cut the create:

Yarn

yarn create react-app my-app

(yarn create comes with Yarn 0.25+ and higher, otherwise see instructions for npm)

Since v0.25.0 yarn has alias for `create-*` commands:

```sh
yarn create react-app my-app
```
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this line here before? I think it should be removed.

It will create a directory called `my-app` inside the current folder.<br>
Inside that directory, it will generate the initial project structure and install the transitive dependencies:

Expand Down