Document how to install a dependency #223
Conversation
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla - and if you have received this in error or have any questions, please drop us a line at cla@fb.com. Thanks! |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
ghost
added
the
| @@ -70,6 +70,14 @@ You don’t have to ever use `eject`. The curated feature set is suitable for sm | |||
|
|
|||
| ## How To... | |||
|
|
|||
| ### Install a Dependency | |||
|
|
|||
| The generated project only includes *build* dependencies. Project-specific dependencies (Redux, React Router, etc.) must be installed separately. These dependencies can be installed with `npm`, without having to modify any existing configuration. | |||
There was a problem hiding this comment.
The generated project only includes build dependencies.
Because npm install --save <library-name> is considered a build dependency too the above sentence looks confusing to me.
Also I consider React and ReactDOM as project-specific dependencies too.
I would like to suggest a slighty change:
The generated project includes React and ReactDOM as dependencies and Create React App as a development dependency. Other dependencies (Redux, React Router, etc.) can be installed with
npm, without having to modify any existing configuration.
There was a problem hiding this comment.
Good point about React and ReactDOM also being dependencies. I like the explicitness of your copy, thanks for the suggestion!
danthareja
force-pushed
the
docs/install-dependency
branch
from
504f0c3
to
6ae333e
Compare
| @@ -70,6 +70,14 @@ You don’t have to ever use `eject`. The curated feature set is suitable for sm | |||
|
|
|||
| ## How To... | |||
|
|
|||
| ### Install a Dependency | |||
|
|
|||
| The generated project includes React and ReactDOM as dependencies and this package, `react-scripts`, as a development dependency. Other dependencies (Redux, React Router, etc.) can be installed with `npm`, without having to modify any existing configuration. | |||
There was a problem hiding this comment.
Let’s change it to:
The generated project includes React and ReactDOM as dependencies. It also includes a set of scripts used by Create React App as a development dependency.
There was a problem hiding this comment.
Let’s avoid passive and trim the sentence down :
You may install other dependencies (for example, React Router) with
npm:
There was a problem hiding this comment.
Good suggestions - thanks!
danthareja
force-pushed
the
docs/install-dependency
branch
from
6ae333e
to
651a254
Compare
|
Bump @gaearon |
|
This looks good, thanks @danthareja! |
Fixed problem with tsconfig.json baseUrl and paths
Closes #217