facebook/create-react-app


Set up a modern web app by running one command.

https://facebook.github.io/create-react-app/

License: MIT

Language: JavaScript

Keywords: build-tools, react, zero-configuration


Create React App Build Status PRs Welcome

Create React apps with no build configuration.

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

Quick Overview

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

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

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.

npm start

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.

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

Creating an App

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 use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.

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

npx

npx create-react-app my-app

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

npm

npm init react-app my-app

npm init <initializer> is available in npm 6+

Yarn

yarn create react-app my-app

yarn create is available in Yarn 0.25+

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:

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:

npm start or yarn start

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.

Build errors

npm test or yarn test

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

Read more about testing.

npm run build or yarn 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.

User Guide

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

How to Update to New Versions?

Please refer to the User Guide for this and other information.

Philosophy

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

What’s Included?

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-first service worker and a web app manifest, meeting all the Progressive Web App criteria. (Note: Using the service worker is opt-in as of react-scripts@2.0.0 and higher)
  • Hassle-free updates for the above tools with a single dependency.

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

The tradeoff is that these 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.

Popular Alternatives

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 few common cases where you might want to try something else:

  • If you want to try React without hundreds of transitive build tool dependencies, consider using a single HTML file or an online sandbox instead.

  • If you need to integrate React code with a server-side template framework like Rails, Django or Symfony, or if you’re not building a single-page app, consider using nwb, or Neutrino which are more flexible. For Rails specifically, you can use Rails Webpacker. For Symfony, try Symfony's Webpack Encore.

  • If you need to publish a React component, nwb can also do this, as well as Neutrino's react-components preset.

  • If you want to do server rendering with React and Node.js, check out Next.js or Razzle. Create React App is agnostic of the backend, and just produces static HTML/JS/CSS bundles.

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

  • Finally, if you need more customization, check out Neutrino and its React preset.

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

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

Contributing

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

React Native

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

Acknowledgements

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

License

Create React App is open source software licensed as MIT.

Project Statistics

Sourcerank 24
Repository Size 7.84 MB
Stars 60,715
Forks 13,222
Watchers 1,739
Open issues 334
Dependencies 987
Contributors 582
Tags 250
Created
Last updated
Last pushed

Top Contributors See all

Dan Abramov Joe Haddad Ville Immonen Christopher Chedeau Kristofer Selbekk Ian Sutherland Ade Viankakrisna Fadlil Jack Zhao Max Stoiber Tharaka Wijebandara Jeffrey Posnick Bruno Lemos Ian Schmitz Andreas Cederström Fabrizio Castellarin Brian Ng Ro Savage Amy Lam Bond Maël Nison

Packages Referencing this Repo

babel-plugin-weus-named-asset-import
Babel plugin for named asset imports in Create React App
Latest release 0.1.4 - Published - 60.7K stars
react-fancy-scripts
Configuration and scripts for Create React App.
Latest release 1.0.10 - Updated - 60.7K stars
react-scripts-tr
Custom react-scripts build ignore build/img/uploads folder
Latest release 1.0.11 - Published - 60.7K stars
react-scripts-turn-on-babelrc
Configuration and scripts for Create React App.
Latest release 1.1.0 - Published - 60.7K stars
react-scripts-k-ramel
Configuration and scripts for Create React App.
Latest release 0.0.1 - Published - 60.7K stars
react-scripts-jordy
Create react app according to Jordy
Latest release 1.1.0 - Published - 60.7K stars
react-scripts-add-gen
Configuration and scripts for Create React App.
Latest release 1.1.2 - Updated - 60.7K stars
vojtech-giveth-react-scripts
Configuration and scripts for Create React App. Update uglifyjs-webpack-plugin to 1.0.0-beta.2 to...
Latest release 1.1.4 - Published - 60.7K stars
testing-react-scripts
Testing customization with react-scripts
Latest release 0.0.0 - Published - 60.7K stars
@danproudfeet/react-dev-utils
Webpack utilities used by Create React App
Latest release 6.0.0-beta-1 - Published - 60.7K stars
@brianhpedersen/react-scripts
Configuration and scripts for Create React App.
Latest release 1.1.2 - Updated - 60.7K stars
babel-preset-kiaba-react-app
Babel preset used by Create React App
Latest release 3.1.6 - Updated - 60.7K stars
@dpwolfe/babel-preset-react-app
Babel preset used by Create React App
Latest release 3.1.1 - Published - 60.7K stars
@trp/react-scripts
Configuration and scripts for Create React App.
Latest release 0.0.1 - Published - 60.7K stars
kiaba-create-react-app
Create React apps with no build configuration.
Latest release 1.5.31 - Updated - 60.7K stars
kiaba-react-scripts
Configuration and scripts for Create React App.
Latest release 2.2.58 - Updated - 60.7K stars
@phenax/custom-react-scripts
Configuration and scripts for Create React App.
Latest release 2.0.0 - Updated - 60.7K stars
@goodforonefare/react-dev-utils
Webpack utilities used by Create React App
Latest release 5.0.1-beta.1 - Updated - 60.7K stars
@kanikarphan/react-scripts
Configuration and scripts for Create React App.
Latest release 1.2.6 - Updated - 60.7K stars
react-scripts-integration
Configuration and scripts for Create React App.
Latest release 1.1.1 - Published - 60.7K stars

Recent Tags See all

react-scripts@2.1.1 November 01, 2018
react-scripts@2.1.1 November 01, 2018
react-error-overlay@5.1.0 November 01, 2018
react-dev-utils@6.1.1 November 01, 2018
react-dev-utils@6.1.1 November 01, 2018
create-react-app@2.1.1 November 01, 2018
babel-preset-react-app@6.1.0 November 01, 2018
babel-plugin-named-asset-import@0.2.3 November 01, 2018
v2.1.1 November 01, 2018
v2.1.0 October 30, 2018
react-scripts@2.1.0 October 30, 2018
react-error-overlay@5.0.6 October 30, 2018
react-dev-utils@6.1.0 October 30, 2018
eslint-config-react-app@3.0.5 October 30, 2018
create-react-app@2.1.0 October 30, 2018

Interesting Forks See all

kitze/custom-react-scripts
[DEPRECATED, use customize-cra] Allow custom config for create-react-app without ejecting
JavaScript - MIT - Last pushed - 959 stars - 113 forks
infernojs/create-inferno-app
Create Inferno apps with no build configuration.
This repository is no longer available - 320 stars - 35 forks
just-boris/create-preact-app
Create Preact apps with no build configuration.
JavaScript - MIT - Last pushed - 56 stars - 3 forks
bem/create-bem-react-app
Create BEM React apps with no build configuration.
JavaScript - Last pushed - 27 stars - 8 forks
wmonk/create-react-app
Create React apps with no build configuration.
JavaScript - MIT - Last pushed - 15 stars - 5 forks

Something wrong with this page? Make a suggestion

Last synced: 2018-12-17 08:03:25 UTC