diff --git a/packages/cra-template/template/README.md b/packages/cra-template/template/README.md index 58beeaccd87e230076cab531b8f418f40b6d1aeb..5f85e20a91ec8462a88fa2cc42c7b505a46926a7 100644 --- a/packages/cra-template/template/README.md +++ b/packages/cra-template/template/README.md @@ -1,70 +1,73 @@ -# Getting Started with Create React App +Creating an App -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +You’ll need to have Node 14.0.0 or later version on your local development machine (but it’s not required on the server). We recommend using the latest LTS version. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects. -## Available Scripts +To create a new app, you may choose one of the following methods: -In the project directory, you can run: +npx -### `npm start` +npx create-react-app my-app +(npx is a package runner tool that comes with npm 5.2+ and higher, see instructions for older npm versions) -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in your browser. +npm -The page will reload when you make changes.\ -You may also see any lint errors in the console. +npm init react-app my-app +npm init <initializer> is available in npm 6+ -### `npm test` +Yarn -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +yarn create react-app my-app +yarn create <starter-kit-package> is available in Yarn 0.25+ -### `npm run build` +It will create a directory called my-app inside the current folder. +Inside that directory, it will generate the initial project structure and install the transitive dependencies: -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `npm run eject` - -**Note: this is a one-way operation. Once you `eject`, you can't go back!** - -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. +my-app +├── README.md +├── node_modules +├── package.json +├── .gitignore +├── public +│ ├── favicon.ico +│ ├── index.html +│ └── manifest.json +└── src + ├── App.css + ├── App.js + ├── App.test.js + ├── index.css + ├── index.js + ├── logo.svg + └── serviceWorker.js + └── setupTests.js +No configuration or complicated folder structures, only the files you need to build your app. +Once the installation is done, you can open your project folder: -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. +cd my-app +Inside the newly created project, you can run some built-in commands: -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. +npm start or yarn start -## Learn More +Runs the app in development mode. +Open http://localhost:3000 to view it in the browser. -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). +The page will automatically reload if you make changes to the code. +You will see the build errors and lint warnings in the console. -To learn React, check out the [React documentation](https://reactjs.org/). +Build errors -### Code Splitting +npm test or yarn test -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) +Runs the test watcher in an interactive mode. +By default, runs tests related to files changed since the last commit. -### Analyzing the Bundle Size +Read more about testing. -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) +npm run build or yarn build -### Making a Progressive Web App - -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) - -### Advanced Configuration - -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) - -### Deployment - -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) +Builds the app for production to the build folder. +It correctly bundles React in production mode and optimizes the build for the best performance. -### `npm run build` fails to minify +The build is minified and the filenames include the hashes. -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) +Your app is ready to be deployed.