Create React App is an officially supported way to create single-page React applications. It offers a modern build setup with no configuration.
npx create-react-app my-appcd my-appnpm start
If you've previously installed
npm install -g create-react-app, we recommend you uninstall the package using
npm uninstall -g create-react-appto ensure that
npxalways uses the latest version.
Then open http://localhost:3000/ to see your app.
When you’re ready to deploy to production, create a minified bundle with
npm run build.
Get Started Immediately
You don’t need to install or configure tools like Webpack or Babel. They are preconfigured and hidden so that you can focus on the code.
Create a project, and you’re good to go.
Creating an App
You’ll need to have Node >= 8.10 on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to 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
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+
Selecting a template
You can now optionally start a new app from a template by appending
--template [template-name] to the creation command.
If you don't select a template, we'll create your project with our base template.
Templates are always named in the format
cra-template-[template-name], however you only need to provide the
[template-name] to the creation command.
npx create-react-app my-app --template [template-name]
You can find a list of available templates by searching for "cra-template-*" on npm.
Our Custom Templates documentation describes how you can build your own template.
Creating a TypeScript app
You can start a new TypeScript app using templates. To use our provided TypeScript template, append
--template typescript to the creation command.
npx create-react-app my-app --template typescript
If you already have a project and would like to add TypeScript, see our Adding TypeScript documentation.
Selecting a package manager
When you create a new app, the CLI will use Yarn to install dependencies (when available). If you have Yarn installed, but would prefer to use npm, you can append
--use-npm to the creation command. For example:
npx create-react-app my-app --use-npm
Running any of these commands 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:
my-app├── README.md├── node_modules├── package.json├── .gitignore├── public│ ├── favicon.ico│ ├── index.html│ ├── logo192.png│ ├── logo512.png│ ├── manifest.json│ └── robots.txt└── src├── App.css├── App.js├── App.test.js├── index.css├── index.js├── logo.svg└── serviceWorker.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:
Inside the newly created project, you can run some built-in commands:
npm start or
Runs the app in development mode. Open http://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.
npm test or
Runs the test watcher in an interactive mode. By default, runs tests related to files changed since the last commit.
npm run build or
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.