Before you get started

Getting started

To be able to get started easily, we encourage you to use Create React App. It is a zero configuration command-line tool to rapidly bootstrap React projects. By using this you won't need to go through webpack configuration and you will be able to code right away.

Installation

Run the following commands to get started:

npx create-react-app my-app
cd my-app
npm start

This will runs the app in the development mode, and live-reload as you make changes.

Open http://localhost:3000 to view it in the browser.

Folder Structure

After creation, your project should something look like this:

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
    └── registerServiceWorker.js

Real world applications can have any number of components, ranging from a handful to thousands. Having all of them in a single file is impractical, so we encourage you to structure them into modules / folders.

This allows you to keep your applications well structured and easy to work with. You can create a components folder under /src and create a folder for each component, where you will be able to colocate the CSS styles and any other resources the component may require.

For the project to build, these files must exist with exact filenames:

• public/index.html is the page template;

• src/index.js is the JavaScript entry point.

You can delete or rename the other files.

Go further

List of Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode. See the section about running tests for more information.

npm run build

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 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.

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.

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.