Repository files navigation

This repo was originally archived on date Jul 16 2019, however, it was found to still be in use by some production services. The repo should be considered deprecated, but will be kept unarchived whilst it is still in use in production.

Create React apps with no build configuration.

• Creating an App – How to create a new app.
• User Guide – How to develop apps bootstrapped with Create React App.

Create React App works on macOS, Windows, and Linux.
If something doesn’t work, pleasefile an issue.

npx create-react-app my-appcd my-appnpm start

(npx comes with npm 5.2+ and higher, seeinstructions for older npm versions)

Then openhttp://localhost:3000/ to see your app.
When you’re ready to deploy to production, create a minified bundle withnpm run build.

Youdon’t need to install or configure tools like Webpack or Babel.
They are preconfigured and hidden so that you can focus on the code.

Just create a project, and you’re good to go.

You’ll need to have Node 8.10.0 or later on your local development machine (but it’s not required on the server). You can usenvm (macOS/Linux) ornvm-windows to easily switch Node versions between different projects.

To create a new app, you may choose one of the following methods:

npx create-react-app my-app

(npx comes with npm 5.2+ and higher, seeinstructions for older npm versions)

npm init react-app my-app

npm init <initializer> is available in npm 6+

yarn create react-app my-app

yarn create is available in Yarn 0.25+

It will create a directory calledmy-app inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies:

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

No configuration or complicated folder structures, just the files you need to build your app.
Once the installation is done, you can open your project folder:

cd my-app

Inside the newly created project, you can run some built-in commands:

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

The page will automatically reload if you make changes to the code.
You will see the build errors and lint warnings in the console.

Runs the test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.

Read more about testing.

Builds the app for production to thebuild 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.

You can find detailed instructions on using Create React App and many tips inits documentation.

Please refer to theUser Guide for this and other information.

• One Dependency: There is just one build dependency. It uses Webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them.

• No Configuration Required: You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.

• No Lock-In: You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.

Your environment will have everything you need to build a modern single-page React app:

• React, JSX, ES6, TypeScript and Flow syntax support.
• Language extras beyond ES6 like the object spread operator.
• Autoprefixed CSS, so you don’t need-webkit- or other prefixes.
• A fast interactive unit test runner with built-in support for coverage reporting.
• A live development server that warns about common mistakes.
• A build script to bundle JS, CSS, and images for production, with hashes and sourcemaps.
• An offline-firstservice worker and aweb app manifest, meeting all theProgressive Web App criteria. (Note: Using the service worker is opt-in as ofreact-scripts@2.0.0 and higher)
• Hassle-free updates for the above tools with a single dependency.

Check outthis guide for an overview of how these tools fit together.

The tradeoff is thatthese tools are preconfigured to work in a specific way. If your project needs more customization, you can"eject" and customize it, but then you will need to maintain this configuration.

Create React App is a great fit for:

• Learning React in a comfortable and feature-rich development environment.
• Starting new single-page React applications.
• Creating examples with React for your libraries and components.

Here are a few common cases where you might want to try something else:

• If you want totry React without hundreds of transitive build tool dependencies, considerusing a single HTML file or an online sandbox instead.

• If you need tointegrate React code with a server-side template framework like Rails, Django or Symfony, or if you’renot building a single-page app, consider usingnwb, orNeutrino which are more flexible. For Rails specifically, you can useRails Webpacker. For Symfony, trySymfony's Webpack Encore.

• If you need topublish a React component,nwb canalso do this, as well asNeutrino's react-components preset.

• If you want to doserver rendering with React and Node.js, check outNext.js orRazzle. Create React App is agnostic of the backend, and just produces static HTML/JS/CSS bundles.

• If your website ismostly static (for example, a portfolio or a blog), consider usingGatsby instead. Unlike Create React App, it pre-renders the website into HTML at the build time.

• Finally, if you needmore customization, check outNeutrino and itsReact preset.

All of the above tools can work with little to no configuration.

If you prefer configuring the build yourself,follow this guide.

We'd love to have your helping hand oncreate-react-app! SeeCONTRIBUTING.md for more information on what we're looking for and how to get started.

Looking for something similar, but for React Native?
Check outExpo CLI.

We are grateful to the authors of existing related projects for their ideas and collaboration:

• @eanplatter
• @insin
• @mxstbr

Create React App is open source softwarelicensed as MIT.