README.md 5.25 KB
Newer Older
Dan Abramov's avatar
Dan Abramov committed
1

2
# Create React App
Dan Abramov's avatar
Dan Abramov committed
3

Dan Abramov's avatar
Dan Abramov committed
4
Create React apps with no build configuration.
Dan Abramov's avatar
Dan Abramov committed
5

Dan Abramov's avatar
Dan Abramov committed
6
* **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.
Dan Abramov's avatar
Dan Abramov committed
7

Dan Abramov's avatar
Dan Abramov committed
8
* **Zero Configuration:** There are no configuration files or command line options. Configuring both development and production builds is handled for you so you can focus on writing code.
Dan Abramov's avatar
Dan Abramov committed
9

Dan Abramov's avatar
Dan Abramov committed
10
* **No Lock-In:** You can “graduate” 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 where we left off.
Dan Abramov's avatar
Dan Abramov committed
11

Dan Abramov's avatar
Dan Abramov committed
12
## Installation
Dan Abramov's avatar
Dan Abramov committed
13

Dan Abramov's avatar
Dan Abramov committed
14
Install it once globally:
Dan Abramov's avatar
Dan Abramov committed
15

Dan Abramov's avatar
Dan Abramov committed
16
17
18
```sh
npm install -g create-react-app
```
Dan Abramov's avatar
Dan Abramov committed
19

Dan Abramov's avatar
Dan Abramov committed
20
## Usage
Dan Abramov's avatar
Dan Abramov committed
21

Dan Abramov's avatar
Dan Abramov committed
22
To create a new app, run:
Dan Abramov's avatar
Dan Abramov committed
23

Dan Abramov's avatar
Dan Abramov committed
24
25
26
27
```sh
create-react-app my-app
cd my-app
```
Dan Abramov's avatar
Dan Abramov committed
28

Dan Abramov's avatar
Dan Abramov committed
29
It will create a directory called `my-app` inside the current folder.  
Dan Abramov's avatar
Dan Abramov committed
30

Dan Abramov's avatar
Dan Abramov committed
31
32
Inside that directory, it will generate the initial project structure and install the transient dependencies.  
Once the installation is done, you can run some commands inside the project folder!
Dan Abramov's avatar
Dan Abramov committed
33

Dan Abramov's avatar
Dan Abramov committed
34
### `npm start`
Dan Abramov's avatar
Dan Abramov committed
35

Dan Abramov's avatar
Dan Abramov committed
36
37
Runs the app in the development mode.  
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Dan Abramov's avatar
Dan Abramov committed
38

Dan Abramov's avatar
Dan Abramov committed
39
40
The page will reload if you make edits.  
You will also see any lint errors in the console.
Dan Abramov's avatar
Dan Abramov committed
41

Dan Abramov's avatar
Dan Abramov committed
42
### `npm run build`
Dan Abramov's avatar
Dan Abramov committed
43

Dan Abramov's avatar
Dan Abramov committed
44
45
Builds the app for production to the `build` folder.  
It correctly bundles React in production mode and optimizes the build for the best performance.
Dan Abramov's avatar
Dan Abramov committed
46

Dan Abramov's avatar
Dan Abramov committed
47
48
The build is minified and the filenames include the hashes.  
Your app is ready to be deployed!
49

Dan Abramov's avatar
Dan Abramov committed
50
### `npm run graduate`
51

Dan Abramov's avatar
Dan Abramov committed
52
**Note: this is a one-way operation. Once you “graduate”, you can’t go back!**
53

Dan Abramov's avatar
Dan Abramov committed
54
If you aren’t satisfied with the build tool and configuration choices, you can “graduate” at any time. This command will remove the single build dependency from your project.
55

Dan Abramov's avatar
Dan Abramov committed
56
Instead, it will copy all the configuration files and the transient dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `graduate` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
57

Dan Abramov's avatar
Dan Abramov committed
58
You don’t have to ever graduate. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obliged 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.
59

Dan Abramov's avatar
Dan Abramov committed
60
## What’s Inside?
61

Dan Abramov's avatar
Dan Abramov committed
62
The tools used by Create React App are subject to change.  
Dan Abramov's avatar
Dan Abramov committed
63
Currently it is a thin layer on top of many amazing community projects, such as:
64

Dan Abramov's avatar
Dan Abramov committed
65
66
67
68
69
70
71
72
* [webpack](https://webpack.github.io/)
* [webpack-dev-server](https://github.com/webpack/webpack-dev-server)
* [Babel](http://babeljs.io/) with [preset-es2015](https://www.npmjs.com/package/babel-preset-es2015), [preset-es2016](https://www.npmjs.com/package/babel-preset-es2016) and [transform-rest-spread](https://babeljs.io/docs/plugins/transform-object-rest-spread/)
* [Autoprefixer](https://github.com/postcss/autoprefixer)
* [html-webpack-plugin](https://github.com/ampedandwired/html-webpack-plugin)
* [style-loader](https://github.com/webpack/style-loader)
* [ESLint](http://eslint.org/)
* [eslint-config-airbnb](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb)
Dan Abramov's avatar
Dan Abramov committed
73
* and more.
74

Dan Abramov's avatar
Dan Abramov committed
75
All of them are transient dependencies of the provided npm package so you don’t need to worry about upgrading them or resolving conflicts.
76

Dan Abramov's avatar
Dan Abramov committed
77
## Limitations
78

Dan Abramov's avatar
Dan Abramov committed
79
80
81
82
83
84
85
Our goal is to provide a tool that bootstraps a minimal production-ready React project with a great developer experience and sane defaults.

This is why many features such as server rendering, experimental Babel plugins, or custom ESLint configuration, are not supported. It is hard to add features that would work for everyone without adding configuration. Having no configuration is an explicit design decision of this project. Currently, even running tests is not supported, although this limitation is temporary.

If you want an advanced feature, you can still use this tool, and later run `npm run graduate` (but then there’s no going back!)

## You Don’t Have to Use This
Dan Abramov's avatar
Dan Abramov committed
86

Dan Abramov's avatar
Dan Abramov committed
87
This is not the “one true way” to create React apps. You don’t need to port your project to use this if you’re happy with your setup.
Dan Abramov's avatar
Dan Abramov committed
88

Dan Abramov's avatar
Dan Abramov committed
89
Historically it has been easy to gradually adopt React, but many people create new single-page React apps from scratch every day. We’ve heard [loud and clear](https://medium.com/@ericclemmons/javascript-fatigue-48d4011b6fc4) that this process can be error-prone and tedious, especially if this is your first JavaScript build stack.
Dan Abramov's avatar
Dan Abramov committed
90

Dan Abramov's avatar
Dan Abramov committed
91
This project is an attempt to figure out a good way to start developing React apps. We don’t claim it’s the best possible stack, and there are intentional limitations, but we think you can ship a production app with it, and with your help we’ll make it better over time.
Dan Abramov's avatar
Dan Abramov committed
92
93
94

## Contibuting

Max's avatar
Max committed
95
Clone the repo and run `npm install` in the root and the `global-cli` folder.
96

Dan Abramov's avatar
Dan Abramov committed
97
98
Once it is done, you can modify any file locally and run `npm start` or `npm run build` just like in a generated project.  
If you want to try out the end-to-end flow with the global CLI, you can do this too:
99
100
101
102
103

```
npm run create-react-app my-app
cd my-app
```
Dan Abramov's avatar
Dan Abramov committed
104

Dan Abramov's avatar
Dan Abramov committed
105
and then run `npm start` or `npm run build`.