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

Replace NPM with Yarn in quick start guide #7966

Merged
merged 1 commit into from
Aug 20, 2021
Merged

Replace NPM with Yarn in quick start guide #7966

merged 1 commit into from
Aug 20, 2021

Conversation

cravend
Copy link
Contributor

@cravend cravend commented Aug 20, 2021

Description

The latest version of create-react-app uses Yarn as the package manager, not NPM (even though it's invoked with npx). Because of this, specifying npm install as step 2 of the quick start will likely cause confusion for new learners.

Fix

This changes npm install to yarn add in the quick start guide. I don't know if there are any other installation guides in the docs; I took a look and didn't see any but it's possible I missed something.

@pshrmn
Copy link
Contributor

pshrmn commented Aug 20, 2021

From what I've generally seen in documentation, yarn add is included as a supplementary way to install, not exclusive.

# NPM
npm install react-router-dom

# Yarn
yarn add react-router-dom

@cravend
Copy link
Contributor Author

cravend commented Aug 20, 2021

Yeah, that's an option too! The reason I didn't include both is because the documentation seems to be designed to used in one fluid motion (run create react app, move into the folder, then install react-router), so I figured anyone who deviated from that path (i.e. using NPM) will know enough to change the commands they run.

@timdorr
Copy link
Member

timdorr commented Aug 20, 2021

@pshrmn That makes sense for a plain project, but this is coming after CRA installs, which will give you a yarn setup. So, running this command would give you two lockfiles (yarn.lock and package-lock.json), which might be confusing to some folks.

Thanks for the update!

@timdorr timdorr merged commit df9d7d4 into remix-run:main Aug 20, 2021
@cravend cravend deleted the patch-1 branch August 20, 2021 19:12
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

Successfully merging this pull request may close these issues.

3 participants