Skip to content

Commit

Permalink
Add explanation for adding everything as dependencies to docs (#6082)
Browse files Browse the repository at this point in the history
* Update available-scripts.md

add the reason for adding packages as dependencies

* Update available-scripts.md

* Update available-scripts.md

* Update available-scripts.md


Co-authored-by: Amy Lam <amy.r.lam@gmail.com>
Co-authored-by: Ian Sutherland <ian@iansutherland.ca>
  • Loading branch information
3 people committed Apr 3, 2019
1 parent d42f888 commit e630238
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docusaurus/docs/available-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ Your app is ready to be deployed! See the section about [deployment](deployment.

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc.) into your project as dependencies in `package.json`. Technically, the distinction between dependencies and development dependencies is pretty arbitrary for front-end apps that produce static bundles.

In addition, it used to cause problems with some hosting platforms that didn't install development dependencies (and thus weren't able to build the project on the server or test it right before deployment). You are free to rearrange your dependencies in `package.json` as you see fit.

All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

2 comments on commit e630238

@attaradev
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@iansu, My name was missing in the authors

@amyrlam
Copy link
Contributor

@amyrlam amyrlam commented on e630238 Apr 3, 2019

Choose a reason for hiding this comment

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

We manually deploy docs, your name will show up when they are deployed. Here's the preview of docs on master: https://create-react-app.netlify.com/create-react-app/docs/available-scripts

Please sign in to comment.