README.md 61.4 KB
Newer Older
Dan Abramov's avatar
Dan Abramov committed
1
2
This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).

Dan Abramov's avatar
Dan Abramov committed
3
Below you will find some information on how to perform common tasks.<br>
4
You can find the most recent version of this guide [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).
5

Manav Sehgal's avatar
Manav Sehgal committed
6
7
## Table of Contents

Dan Abramov's avatar
Dan Abramov committed
8
- [Updating to New Releases](#updating-to-new-releases)
Manav Sehgal's avatar
Manav Sehgal committed
9
10
11
- [Sending Feedback](#sending-feedback)
- [Folder Structure](#folder-structure)
- [Available Scripts](#available-scripts)
12
  - [npm start](#npm-start)
Dan Abramov's avatar
Dan Abramov committed
13
  - [npm test](#npm-test)
14
15
  - [npm run build](#npm-run-build)
  - [npm run eject](#npm-run-eject)
16
- [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor)
Dan Abramov's avatar
Dan Abramov committed
17
- [Displaying Lint Output in the Editor](#displaying-lint-output-in-the-editor)
18
- [Changing the Page `<title>`](#changing-the-page-title)
Dan Abramov's avatar
Dan Abramov committed
19
20
21
22
23
- [Installing a Dependency](#installing-a-dependency)
- [Importing a Component](#importing-a-component)
- [Adding a Stylesheet](#adding-a-stylesheet)
- [Post-Processing CSS](#post-processing-css)
- [Adding Images and Fonts](#adding-images-and-fonts)
Dan Abramov's avatar
Dan Abramov committed
24
- [Using the `public` Folder](#using-the-public-folder)
25
26
27
  - [Changing the HTML](#changing-the-html)
  - [Adding Assets Outside of the Module System](#adding-assets-outside-of-the-module-system)
  - [When to Use the `public` Folder](#when-to-use-the-public-folder)
28
- [Using Global Variables](#using-global-variables)
Dan Abramov's avatar
Dan Abramov committed
29
30
31
- [Adding Bootstrap](#adding-bootstrap)
- [Adding Flow](#adding-flow)
- [Adding Custom Environment Variables](#adding-custom-environment-variables)
Dan Abramov's avatar
Dan Abramov committed
32
- [Can I Use Decorators?](#can-i-use-decorators)
33
34
35
- [Integrating with an API Backend](#integrating-with-an-api-backend)
  - [Node](#node)
  - [Ruby on Rails](#ruby-on-rails)
Dan Abramov's avatar
Dan Abramov committed
36
- [Proxying API Requests in Development](#proxying-api-requests-in-development)
37
- [Using HTTPS in Development](#using-https-in-development)
Dan Abramov's avatar
Dan Abramov committed
38
- [Generating Dynamic `<meta>` Tags on the Server](#generating-dynamic-meta-tags-on-the-server)
Dan Abramov's avatar
Dan Abramov committed
39
40
41
42
43
44
45
- [Running Tests](#running-tests)
  - [Filename Conventions](#filename-conventions)
  - [Command Line Interface](#command-line-interface)
  - [Version Control Integration](#version-control-integration)
  - [Writing Tests](#writing-tests)
  - [Testing Components](#testing-components)
  - [Using Third Party Assertion Libraries](#using-third-party-assertion-libraries)
46
  - [Initializing Test Environment](#initializing-test-environment)
47
  - [Focusing and Excluding Tests](#focusing-and-excluding-tests)
Dan Abramov's avatar
Dan Abramov committed
48
49
50
51
  - [Coverage Reporting](#coverage-reporting)
  - [Continuous Integration](#continuous-integration)
  - [Disabling jsdom](#disabling-jsdom)
  - [Experimental Snapshot Testing](#experimental-snapshot-testing)
Orta's avatar
Orta committed
52
  - [Editor Integration](#editor-integration)
Dan Abramov's avatar
Dan Abramov committed
53
- [Developing Components in Isolation](#developing-components-in-isolation)
Dan Abramov's avatar
Dan Abramov committed
54
- [Making a Progressive Web App](#making-a-progressive-web-app)
55
- [Deployment](#deployment)
56
  - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing)
57
  - [Building for Relative Paths](#building-for-relative-paths)
58
  - [Firebase](#firebase)
59
  - [GitHub Pages](#github-pages)
60
  - [Heroku](#heroku)
61
  - [Modulus](#modulus)
62
  - [Netlify](#netlify)
63
  - [Now](#now)
64
  - [S3 and CloudFront](#s3-and-cloudfront)
65
  - [Surge](#surge)
66
- [Troubleshooting](#troubleshooting)
67
  - [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes)
68
69
  - [`npm test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra)
  - [`npm run build` silently fails](#npm-run-build-silently-fails)
70
  - [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku)
Dan Abramov's avatar
Dan Abramov committed
71
- [Something Missing?](#something-missing)
Manav Sehgal's avatar
Manav Sehgal committed
72

Dan Abramov's avatar
Dan Abramov committed
73
74
75
76
77
78
79
## Updating to New Releases

Create React App is divided into two packages:

* `create-react-app` is a global command-line utility that you use to create new projects.
* `react-scripts` is a development dependency in the generated projects (including this one).

Vadim Peretokin's avatar
Vadim Peretokin committed
80
You almost never need to update `create-react-app` itself: it delegates all the setup to `react-scripts`.
Dan Abramov's avatar
Dan Abramov committed
81
82
83
84
85
86
87
88
89

When you run `create-react-app`, it always creates the project with the latest version of `react-scripts` so you’ll get all the new features and improvements in newly created apps automatically.

To update an existing project to a new version of `react-scripts`, [open the changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md), find the version you’re currently on (check `package.json` in this folder if you’re not sure), and apply the migration instructions for the newer versions.

In most cases bumping the `react-scripts` version in `package.json` and running `npm install` in this folder should be enough, but it’s good to consult the [changelog](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md) for potential breaking changes.

We commit to keeping the breaking changes minimal so you can upgrade `react-scripts` painlessly.

Dan Abramov's avatar
Dan Abramov committed
90
91
92
93
## Sending Feedback

We are always open to [your feedback](https://github.com/facebookincubator/create-react-app/issues).

94
95
## Folder Structure

96
After creation, your project should look like this:
97
98
99
100
101
102

```
my-app/
  README.md
  node_modules/
  package.json
Dan Abramov's avatar
Dan Abramov committed
103
104
105
  public/
    index.html
    favicon.ico
106
107
108
  src/
    App.css
    App.js
109
    App.test.js
110
111
112
113
114
115
116
    index.css
    index.js
    logo.svg
```

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

Dan Abramov's avatar
Dan Abramov committed
117
* `public/index.html` is the page template;
118
119
120
121
* `src/index.js` is the JavaScript entry point.

You can delete or rename the other files.

Dan Abramov's avatar
Dan Abramov committed
122
You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack.<br>
123
124
You need to **put any JS and CSS files inside `src`**, or Webpack won’t see them.

Dan Abramov's avatar
Dan Abramov committed
125
Only files inside `public` can be used from `public/index.html`.<br>
Dan Abramov's avatar
Dan Abramov committed
126
127
Read instructions below for using assets from JavaScript and HTML.

Dan Abramov's avatar
Dan Abramov committed
128
You can, however, create more top-level directories.<br>
129
130
They will not be included in the production build so you can use them for things like documentation.

Dan Abramov's avatar
Dan Abramov committed
131
132
## Available Scripts

133
In the project directory, you can run:
134
135
136
137
138
139
140
141
142

### `npm start`

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

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

Dan Abramov's avatar
Dan Abramov committed
143
144
### `npm test`

Dan Abramov's avatar
Dan Abramov committed
145
Launches the test runner in the interactive watch mode.<br>
Dan Abramov's avatar
Dan Abramov committed
146
147
See the section about [running tests](#running-tests) for more information.

148
149
150
151
152
153
154
155
### `npm run build`

Builds the app for production to the `build` folder.<br>
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.<br>
Your app is ready to be deployed!

156
157
See the section about [deployment](#deployment) for more information.

158
159
160
161
162
163
### `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.

164
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.
165
166

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

168
169
## Syntax Highlighting in the Editor

Dan Abramov's avatar
Dan Abramov committed
170
To configure the syntax highlighting in your favorite text editor, head to the [relevant Babel documentation page](https://babeljs.io/docs/editors) and follow the instructions. Some of the most popular editors are covered.
171

Dan Abramov's avatar
Dan Abramov committed
172
## Displaying Lint Output in the Editor
Dan Abramov's avatar
Dan Abramov committed
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

>Note: this feature is available with `react-scripts@0.2.0` and higher.

Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plugins for ESLint.

They are not required for linting. You should see the linter output right in your terminal as well as the browser console. However, if you prefer the lint results to appear right in your editor, there are some extra steps you can do.

You would need to install an ESLint plugin for your editor first.

>**A note for Atom `linter-eslint` users**

>If you are using the Atom `linter-eslint` plugin, make sure that **Use global ESLint installation** option is checked:

><img src="http://i.imgur.com/yVNNHJM.png" width="300">

188
Then add this block to the `package.json` file of your project:
Dan Abramov's avatar
Dan Abramov committed
189
190
191
192
193

```js
{
  // ...
  "eslintConfig": {
194
    "extends": "react-app"
Dan Abramov's avatar
Dan Abramov committed
195
196
197
198
199
200
201
  }
}
```

Finally, you will need to install some packages *globally*:

```sh
202
npm install -g eslint-config-react-app@0.3.0 eslint@3.8.1 babel-eslint@7.0.0 eslint-plugin-react@6.4.1 eslint-plugin-import@2.0.1 eslint-plugin-jsx-a11y@2.2.3 eslint-plugin-flowtype@2.21.0
Dan Abramov's avatar
Dan Abramov committed
203
204
205
206
```

We recognize that this is suboptimal, but it is currently required due to the way we hide the ESLint dependency. The ESLint team is already [working on a solution to this](https://github.com/eslint/eslint/issues/3458) so this may become unnecessary in a couple of months.

207
208
209
210
## Changing the Page `<title>`

You can find the source HTML file in the `public` folder of the generated project. You may edit the `<title>` tag in it to change the title from “React App” to anything else.

211
Note that normally you wouldn't edit files in the `public` folder very often. For example, [adding a stylesheet](#adding-a-stylesheet) is done without touching the HTML.
212
213
214
215
216

If you need to dynamically update the page title based on the content, you can use the browser [`document.title`](https://developer.mozilla.org/en-US/docs/Web/API/Document/title) API. For more complex scenarios when you want to change the title from React components, you can use [React Helmet](https://github.com/nfl/react-helmet), a third party library.

Finally, if you use a custom server for your app in production and want to modify the title before it gets sent to the browser, you can follow advice in [this section](#generating-dynamic-meta-tags-on-the-server).

Dan Abramov's avatar
Dan Abramov committed
217
## Installing a Dependency
218
219
220
221
222
223
224

The generated project includes React and ReactDOM as dependencies. It also includes a set of scripts used by Create React App as a development dependency. You may install other dependencies (for example, React Router) with `npm`:

```
npm install --save <library-name>
```

Dan Abramov's avatar
Dan Abramov committed
225
## Importing a Component
Dan Abramov's avatar
Dan Abramov committed
226

Dan Abramov's avatar
Dan Abramov committed
227
This project setup supports ES6 modules thanks to Babel.<br>
Dan Abramov's avatar
Dan Abramov committed
228
229
230
231
While you can still use `require()` and `module.exports`, we encourage you to use [`import` and `export`](http://exploringjs.com/es6/ch_modules.html) instead.

For example:

Dan Abramov's avatar
Dan Abramov committed
232
### `Button.js`
Dan Abramov's avatar
Dan Abramov committed
233
234
235
236
237
238
239
240
241
242
243
244
245

```js
import React, { Component } from 'react';

class Button extends Component {
  render() {
    // ...
  }
}

export default Button; // Don’t forget to use export default!
```

Dan Abramov's avatar
Dan Abramov committed
246
247
### `DangerButton.js`

Dan Abramov's avatar
Dan Abramov committed
248
249
250
251
252
253
254

```js
import React, { Component } from 'react';
import Button from './Button'; // Import a component from another file

class DangerButton extends Component {
  render() {
255
    return <Button color="red" />;
Dan Abramov's avatar
Dan Abramov committed
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
  }
}

export default DangerButton;
```

Be aware of the [difference between default and named exports](http://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281). It is a common source of mistakes.

We suggest that you stick to using default imports and exports when a module only exports a single thing (for example, a component). That’s what you get when you use `export default Button` and `import Button from './Button'`.

Named exports are useful for utility modules that export several functions. A module may have at most one default export and as many named exports as you like.

Learn more about ES6 modules:

* [When to use the curly braces?](http://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281)
* [Exploring ES6: Modules](http://exploringjs.com/es6/ch_modules.html)
* [Understanding ES6: Modules](https://leanpub.com/understandinges6/read#leanpub-auto-encapsulating-code-with-modules)

Dan Abramov's avatar
Dan Abramov committed
274
## Adding a Stylesheet
Dan Abramov's avatar
Dan Abramov committed
275

276
This project setup uses [Webpack](https://webpack.github.io/) for handling all assets. Webpack offers a custom way of “extending” the concept of `import` beyond JavaScript. To express that a JavaScript file depends on a CSS file, you need to **import the CSS from the JavaScript file**:
Dan Abramov's avatar
Dan Abramov committed
277

Dan Abramov's avatar
Dan Abramov committed
278
### `Button.css`
Dan Abramov's avatar
Dan Abramov committed
279
280
281
282
283
284
285

```css
.Button {
  padding: 20px;
}
```

Dan Abramov's avatar
Dan Abramov committed
286
### `Button.js`
Dan Abramov's avatar
Dan Abramov committed
287
288
289
290
291
292
293
294

```js
import React, { Component } from 'react';
import './Button.css'; // Tell Webpack that Button.js uses these styles

class Button extends Component {
  render() {
    // You can use them as regular CSS styles
295
    return <div className="Button" />;
Dan Abramov's avatar
Dan Abramov committed
296
297
298
299
  }
}
```

Dan Abramov's avatar
Dan Abramov committed
300
**This is not required for React** but many people find this feature convenient. You can read about the benefits of this approach [here](https://medium.com/seek-ui-engineering/block-element-modifying-your-javascript-components-d7f99fcab52b). However you should be aware that this makes your code less portable to other build tools and environments than Webpack.
Dan Abramov's avatar
Dan Abramov committed
301

Dan Abramov's avatar
Dan Abramov committed
302
In development, expressing dependencies this way allows your styles to be reloaded on the fly as you edit them. In production, all CSS files will be concatenated into a single minified `.css` file in the build output.
Dan Abramov's avatar
Dan Abramov committed
303

304
If you are concerned about using Webpack-specific semantics, you can put all your CSS right into `src/index.css`. It would still be imported from `src/index.js`, but you could always remove that import if you later migrate to a different build tool.
Dan Abramov's avatar
Dan Abramov committed
305

Dan Abramov's avatar
Dan Abramov committed
306
## Post-Processing CSS
Dan Abramov's avatar
Dan Abramov committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338

This project setup minifies your CSS and adds vendor prefixes to it automatically through [Autoprefixer](https://github.com/postcss/autoprefixer) so you don’t need to worry about it.

For example, this:

```css
.App {
  display: flex;
  flex-direction: row;
  align-items: center;
}
```

becomes this:

```css
.App {
  display: -webkit-box;
  display: -ms-flexbox;
  display: flex;
  -webkit-box-orient: horizontal;
  -webkit-box-direction: normal;
      -ms-flex-direction: row;
          flex-direction: row;
  -webkit-box-align: center;
      -ms-flex-align: center;
          align-items: center;
}
```

There is currently no support for preprocessors such as Less, or for sharing variables across CSS files.

Dan Abramov's avatar
Dan Abramov committed
339
## Adding Images and Fonts
Dan Abramov's avatar
Dan Abramov committed
340
341
342

With Webpack, using static assets like images and fonts works similarly to CSS.

343
You can **`import` an image right in a JavaScript module**. This tells Webpack to include that image in the bundle. Unlike CSS imports, importing an image or a font gives you a string value. This value is the final image path you can reference in your code.
Dan Abramov's avatar
Dan Abramov committed
344
345
346
347
348
349
350

Here is an example:

```js
import React from 'react';
import logo from './logo.png'; // Tell Webpack this JS file uses this image

351
console.log(logo); // /logo.84287d09.png
Dan Abramov's avatar
Dan Abramov committed
352
353
354
355
356
357

function Header() {
  // Import result is the URL of your image
  return <img src={logo} alt="Logo" />;
}

358
export default Header;
Dan Abramov's avatar
Dan Abramov committed
359
360
```

Brian Ng's avatar
Brian Ng committed
361
This ensures that when the project is built, Webpack will correctly move the images into the build folder, and provide us with correct paths.
362

Dan Abramov's avatar
Dan Abramov committed
363
This works in CSS too:
Dan Abramov's avatar
Dan Abramov committed
364
365
366
367
368
369
370

```css
.Logo {
  background-image: url(./logo.png);
}
```

371
372
373
374
Webpack finds all relative module references in CSS (they start with `./`) and replaces them with the final paths from the compiled bundle. If you make a typo or accidentally delete an important file, you will see a compilation error, just like when you import a non-existent JavaScript module. The final filenames in the compiled bundle are generated by Webpack from content hashes. If the file content changes in the future, Webpack will give it a different name in production so you don’t need to worry about long-term caching of assets.

Please be advised that this is also a custom feature of Webpack.

Dan Abramov's avatar
Dan Abramov committed
375
**It is not required for React** but many people enjoy it (and React Native uses a similar mechanism for images).<br>
Dan Abramov's avatar
Dan Abramov committed
376
377
378
379
380
381
An alternative way of handling static assets is described in the next section.

## Using the `public` Folder

>Note: this feature is available with `react-scripts@0.5.0` and higher.

382
383
384
385
386
387
388
389
390
### Changing the HTML

The `public` folder contains the HTML file so you can tweak it, for example, to [set the page title](#changing-the-page-title).
The `<script>` tag with the compiled code will be added to it automatically during the build process.

### Adding Assets Outside of the Module System

You can also add other assets to the `public` folder.

391
Note that we normally encourage you to `import` assets in JavaScript files instead.
392
393
For example, see the sections on [adding a stylesheet](#adding-a-stylesheet) and [adding images and fonts](#adding-images-and-fonts).
This mechanism provides a number of benefits:
Dan Abramov's avatar
Dan Abramov committed
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410

* Scripts and stylesheets get minified and bundled together to avoid extra network requests.
* Missing files cause compilation errors instead of 404 errors for your users.
* Result filenames include content hashes so you don’t need to worry about browsers caching their old versions.

However there is an **escape hatch** that you can use to add an asset outside of the module system.

If you put a file into the `public` folder, it will **not** be processed by Webpack. Instead it will be copied into the build folder untouched.   To reference assets in the `public` folder, you need to use a special variable called `PUBLIC_URL`.

Inside `index.html`, you can use it like this:

```html
<link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
```

Only files inside the `public` folder will be accessible by `%PUBLIC_URL%` prefix. If you need to use a file from `src` or `node_modules`, you’ll have to copy it there to explicitly specify your intention to make this file a part of the build.

Brian Ng's avatar
Brian Ng committed
411
When you run `npm run build`, Create React App will substitute `%PUBLIC_URL%` with a correct absolute path so your project works even if you use client-side routing or host it at a non-root URL.
Dan Abramov's avatar
Dan Abramov committed
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429

In JavaScript code, you can use `process.env.PUBLIC_URL` for similar purposes:

```js
render() {
  // Note: this is an escape hatch and should be used sparingly!
  // Normally we recommend using `import` for getting asset URLs
  // as described in “Adding Images and Fonts” above this section.
  return <img src={process.env.PUBLIC_URL + '/img/logo.png'} />;
}
```

Keep in mind the downsides of this approach:

* None of the files in `public` folder get post-processed or minified.
* Missing files will not be called at compilation time, and will cause 404 errors for your users.
* Result filenames won’t include content hashes so you’ll need to add query arguments or rename them every time they change.

430
431
432
433
434
435
436
437
438
### When to Use the `public` Folder

Normally we recommend importing [stylesheets](#adding-a-stylesheet), [images, and fonts](#adding-images-and-fonts) from JavaScript.
The `public` folder is useful as a workaround for a number of less common cases:

* You need a file with a specific name in the build output, such as [`manifest.webmanifest`](https://developer.mozilla.org/en-US/docs/Web/Manifest).
* You have thousands of images and need to dynamically reference their paths.
* You want to include a small script like [`pace.js`](http://github.hubspot.com/pace/docs/welcome/) outside of the bundled code.
* Some library may be incompatible with Webpack and you have no other option but to include it as a `<script>` tag.
439

440
441
Note that if you add a `<script>` that declares global variables, you also need to read the next section on using them.

442
## Using Global Variables
443
444
445
446
447
448
449
450
451
452
453
454
455

When you include a script in the HTML file that defines global variables and try to use one of these variables in the code, the linter will complain because it cannot see the definition of the variable.

You can avoid this by reading the global variable explicitly from the `window` object, for example:

```js
const $ = window.$;
```

This makes it obvious you are using a global variable intentionally rather than because of a typo.

Alternatively, you can force the linter to ignore any line by adding `// eslint-disable-line` after it.

Dan Abramov's avatar
Dan Abramov committed
456
## Adding Bootstrap
457

Dan Abramov's avatar
Dan Abramov committed
458
You don’t have to use [React Bootstrap](https://react-bootstrap.github.io) together with React but it is a popular library for integrating Bootstrap with React apps. If you need it, you can integrate it with Create React App by following these steps:
459

Dan Abramov's avatar
Dan Abramov committed
460
Install React Bootstrap and Bootstrap from NPM. React Bootstrap does not include Bootstrap CSS so this needs to be installed as well:
461
462
463
464
465
466

```
npm install react-bootstrap --save
npm install bootstrap@3 --save
```

Dan Abramov's avatar
Dan Abramov committed
467
Import Bootstrap CSS and optionally Bootstrap theme CSS in the ```src/index.js``` file:
468

Dan Abramov's avatar
Dan Abramov committed
469
```js
470
471
472
473
import 'bootstrap/dist/css/bootstrap.css';
import 'bootstrap/dist/css/bootstrap-theme.css';
```

Dan Abramov's avatar
Dan Abramov committed
474
Import required React Bootstrap components within ```src/App.js``` file or your custom component files:
475

Dan Abramov's avatar
Dan Abramov committed
476
```js
477
import { Navbar, Jumbotron, Button } from 'react-bootstrap';
478
```
479

Dan Abramov's avatar
Dan Abramov committed
480
Now you are ready to use the imported React Bootstrap components within your component hierarchy defined in the render method. Here is an example [`App.js`](https://gist.githubusercontent.com/gaearon/85d8c067f6af1e56277c82d19fd4da7b/raw/6158dd991b67284e9fc8d70b9d973efe87659d72/App.js) redone using React Bootstrap.
481

Dan Abramov's avatar
Dan Abramov committed
482
## Adding Flow
483

484
Flow is a static type checker that helps you write code with fewer bugs. Check out this [introduction to using static types in JavaScript](https://medium.com/@preethikasireddy/why-use-static-types-in-javascript-part-1-8382da1e0adb) if you are new to this concept.
485

486
Recent versions of [Flow](http://flowtype.org/) work with Create React App projects out of the box. 
487

488
To add Flow to a Create React App project, follow these steps:
489

490
491
492
493
494
495
496
1. Run `npm install --save-dev flow-bin`.
2. Add `"flow": "flow"` to the `scripts` section of your `package.json`.
3. Add `// @flow` to any files you want to type check (for example, to `src/App.js`).

Now you can run `npm run flow` to check the files for type errors.
You can optionally use an IDE like [Nuclide](https://nuclide.io/docs/languages/flow/) for a better integrated experience.
In the future we plan to integrate it into Create React App even more closely.
497

498
To learn more about Flow, check out [its documentation](https://flowtype.org/).
499

Dan Abramov's avatar
Dan Abramov committed
500
## Adding Custom Environment Variables
501

Dan Abramov's avatar
Dan Abramov committed
502
>Note: this feature is available with `react-scripts@0.2.3` and higher.
503
504
505
506
507
508
509

Your project can consume variables declared in your environment as if they were declared locally in your JS files. By
default you will have `NODE_ENV` defined for you, and any other environment variables starting with
`REACT_APP_`. These environment variables will be defined for you on `process.env`. For example, having an environment
variable named `REACT_APP_SECRET_CODE` will be exposed in your JS as `process.env.REACT_APP_SECRET_CODE`, in addition
to `process.env.NODE_ENV`.

510
511
>Note: Changing any environment variables will require you to restart the development server if it is running.

512
513
514
These environment variables can be useful for displaying information conditionally based on where the project is
deployed or consuming sensitive data that lives outside of version control.

515
516
First, you need to have environment variables defined. For example, let’s say you wanted to consume a secret defined
in the environment inside a `<form>`:
517
518

```jsx
Dan Abramov's avatar
Dan Abramov committed
519
520
521
522
523
524
525
526
527
528
render() {
  return (
    <div>
      <small>You are running this application in <b>{process.env.NODE_ENV}</b> mode.</small>
      <form>
        <input type="hidden" defaultValue={process.env.REACT_APP_SECRET_CODE} />
      </form>
    </div>
  );
}
529
530
```

531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
During the build, `process.env.REACT_APP_SECRET_CODE` will be replaced with the current value of the `REACT_APP_SECRET_CODE` environment variable. Remember that the `NODE_ENV` variable will be set for you automatically.

When you load the app in the browser and inspect the `<input>`, you will see its value set to `abcdef`, and the bold text will show the environment provided when using `npm start`:

```html
<div>
  <small>You are running this application in <b>development</b> mode.</small>
  <form>
    <input type="hidden" value="abcdef" />
  </form>
</div>
```

Having access to the `NODE_ENV` is also useful for performing actions conditionally:

```js
if (process.env.NODE_ENV !== 'production') {
  analytics.disable();
}
```

552
The above form is looking for a variable called `REACT_APP_SECRET_CODE` from the environment. In order to consume this
553
554
555
556
557
558
559
value, we need to have it defined in the environment. This can be done using two ways: either in your shell or in
a `.env` file.

### Adding Temporary Environment Variables In Your Shell

Defining environment variables can vary between OSes. It's also important to know that this manner is temporary for the
life of the shell session.
560

Dan Abramov's avatar
Dan Abramov committed
561
#### Windows (cmd.exe)
562
563

```cmd
Dan Abramov's avatar
Dan Abramov committed
564
set REACT_APP_SECRET_CODE=abcdef&&npm start
565
566
```

Dan Abramov's avatar
Dan Abramov committed
567
568
(Note: the lack of whitespace is intentional.)

Dan Abramov's avatar
Dan Abramov committed
569
#### Linux, OS X (Bash)
570
571
572
573
574

```bash
REACT_APP_SECRET_CODE=abcdef npm start
```

575
### Adding Development Environment Variables In `.env`
576

577
>Note: this feature is available with `react-scripts@0.5.0` and higher.
578

Brian Ng's avatar
Brian Ng committed
579
To define permanent environment variables, create a file called `.env` in the root of your project:
580
581
582

```
REACT_APP_SECRET_CODE=abcdef
583
584
```

Dan Abramov's avatar
Dan Abramov committed
585
These variables will act as the defaults if the machine does not explicitly set them.<br>
586
Please refer to the [dotenv documentation](https://github.com/motdotla/dotenv) for more details.
587

588
589
>Note: If you are defining environment variables for development, your CI and/or hosting platform will most likely need
these defined as well. Consult their documentation how to do this. For example, see the documentation for [Travis CI](https://docs.travis-ci.com/user/environment-variables/) or [Heroku](https://devcenter.heroku.com/articles/config-vars).
590

Dan Abramov's avatar
Dan Abramov committed
591
592
## Can I Use Decorators?

Dan Abramov's avatar
Dan Abramov committed
593
Many popular libraries use [decorators](https://medium.com/google-developers/exploring-es7-decorators-76ecb65fb841) in their documentation.<br>
Dan Abramov's avatar
Dan Abramov committed
594
595
596
597
598
599
Create React App doesn’t support decorator syntax at the moment because:

* It is an experimental proposal and is subject to change.
* The current specification version is not officially supported by Babel.
* If the specification changes, we won’t be able to write a codemod because we don’t use them internally at Facebook.

Dan Abramov's avatar
Dan Abramov committed
600
However in many cases you can rewrite decorator-based code without decorators just as fine.<br>
Dan Abramov's avatar
Dan Abramov committed
601
602
603
604
605
606
607
Please refer to these two threads for reference:

* [#214](https://github.com/facebookincubator/create-react-app/issues/214)
* [#411](https://github.com/facebookincubator/create-react-app/issues/411)

Create React App will add decorator support when the specification advances to a stable stage.

608
## Integrating with an API Backend
Dan Abramov's avatar
Dan Abramov committed
609

610
611
612
613
614
615
616
617
618
619
620
These tutorials will help you to integrate your app with an API backend running on another port,
using `fetch()` to access it.

### Node
Check out [this tutorial](https://www.fullstackreact.com/articles/using-create-react-app-with-a-server/). 
You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo).

### Ruby on Rails

Check out [this tutorial](https://www.fullstackreact.com/articles/how-to-get-create-react-app-to-work-with-your-rails-api/). 
You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo-rails).
Dan Abramov's avatar
Dan Abramov committed
621

Dan Abramov's avatar
Dan Abramov committed
622
623
## Proxying API Requests in Development

Dan Abramov's avatar
Dan Abramov committed
624
>Note: this feature is available with `react-scripts@0.2.3` and higher.
Dan Abramov's avatar
Dan Abramov committed
625

Dan Abramov's avatar
Dan Abramov committed
626
People often serve the front-end React app from the same host and port as their backend implementation.<br>
Dan Abramov's avatar
Dan Abramov committed
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
For example, a production setup might look like this after the app is deployed:

```
/             - static server returns index.html with React app
/todos        - static server returns index.html with React app
/api/todos    - server handles any /api/* requests using the backend implementation
```

Such setup is **not** required. However, if you **do** have a setup like this, it is convenient to write requests like `fetch('/api/todos')` without worrying about redirecting them to another host or port during development.

To tell the development server to proxy any unknown requests to your API server in development, add a `proxy` field to your `package.json`, for example:

```js
  "proxy": "http://localhost:4000",
```

643
This way, when you `fetch('/api/todos')` in development, the development server will recognize that it’s not a static asset, and will proxy your request to `http://localhost:4000/api/todos` as a fallback. The development server will only attempt to send requests without a `text/html` accept header to the proxy.
Dan Abramov's avatar
Dan Abramov committed
644
645
646
647

Conveniently, this avoids [CORS issues](http://stackoverflow.com/questions/21854516/understanding-ajax-cors-and-security-considerations) and error messages like this in development:

```
Kamil Burzynski's avatar
Kamil Burzynski committed
648
Fetch API cannot load http://localhost:4000/api/todos. No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'http://localhost:3000' is therefore not allowed access. If an opaque response serves your needs, set the request's mode to 'no-cors' to fetch the resource with CORS disabled.
Dan Abramov's avatar
Dan Abramov committed
649
650
```

651
Keep in mind that `proxy` only has effect in development (with `npm start`), and it is up to you to ensure that URLs like `/api/todos` point to the right thing in production. You don’t have to use the `/api` prefix. Any unrecognized request without a `text/html` accept header will be redirected to the specified `proxy`.
Dan Abramov's avatar
Dan Abramov committed
652

Dan Abramov's avatar
Dan Abramov committed
653
Currently the `proxy` option only handles HTTP requests, and it won’t proxy WebSocket connections.<br>
Dan Abramov's avatar
Dan Abramov committed
654
655
656
657
658
If the `proxy` option is **not** flexible enough for you, alternatively you can:

* Enable CORS on your server ([here’s how to do it for Express](http://enable-cors.org/server_expressjs.html)).
* Use [environment variables](#adding-custom-environment-variables) to inject the right server host and port into your app.

659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
## Using HTTPS in Development

>Note: this feature is available with `react-scripts@0.4.0` and higher.

You may require the dev server to serve pages over HTTPS. One particular case where this could be useful is when using [the "proxy" feature](#proxying-api-requests-in-development) to proxy requests to an API server when that API server is itself serving HTTPS.

To do this, set the `HTTPS` environment variable to `true`, then start the dev server as usual with `npm start`:

#### Windows (cmd.exe)

```cmd
set HTTPS=true&&npm start
```

(Note: the lack of whitespace is intentional.)

#### Linux, OS X (Bash)

```bash
HTTPS=true npm start
```

Note that the server will use a self-signed certificate, so your web browser will almost definitely display a warning upon accessing the page.

Dan Abramov's avatar
Dan Abramov committed
683
## Generating Dynamic `<meta>` Tags on the Server
684
685

Since Create React App doesn’t support server rendering, you might be wondering how to make `<meta>` tags dynamic and reflect the current URL. To solve this, we recommend to add placeholders into the HTML, like this:
686
687
688
689
690

```html
<!doctype html>
<html lang="en">
  <head>
Dan Abramov's avatar
Dan Abramov committed
691
692
    <meta property="og:title" content="%OG_TITLE%">
    <meta property="og:description" content="%OG_DESCRIPTION%">
693
694
```

Dan Abramov's avatar
Dan Abramov committed
695
Then, on the server, regardless of the backend you use, you can read `index.html` into memory and replace `%OG_TITLE%`, `%OG_DESCRIPTION%`, and any other placeholders with values depending on the current URL. Just make sure to sanitize and escape the interpolated values so that they are safe to embed into HTML!
696
697
698

If you use a Node server, you can even share the route matching logic between the client and the server. However duplicating it also works fine in simple cases.

Dan Abramov's avatar
Dan Abramov committed
699
700
## Running Tests

Dan Abramov's avatar
Dan Abramov committed
701
>Note: this feature is available with `react-scripts@0.3.0` and higher.<br>
Dan Abramov's avatar
Dan Abramov committed
702
703
>[Read the migration guide to learn how to enable it in older projects!](https://github.com/facebookincubator/create-react-app/blob/master/CHANGELOG.md#migrating-from-023-to-030)

704
Create React App uses [Jest](https://facebook.github.io/jest/) as its test runner. To prepare for this integration, we did a [major revamp](https://facebook.github.io/jest/blog/2016/09/01/jest-15.html) of Jest so if you heard bad things about it years ago, give it another try.
Dan Abramov's avatar
Dan Abramov committed
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721

Jest is a Node-based runner. This means that the tests always run in a Node environment and not in a real browser. This lets us enable fast iteration speed and prevent flakiness.

While Jest provides browser globals such as `window` thanks to [jsdom](https://github.com/tmpvar/jsdom), they are only approximations of the real browser behavior. Jest is intended to be used for unit tests of your logic and your components rather than the DOM quirks.

We recommend that you use a separate tool for browser end-to-end tests if you need them. They are beyond the scope of Create React App.

### Filename Conventions

Jest will look for test files with any of the following popular naming conventions:

* Files with `.js` suffix in `__tests__` folders.
* Files with `.test.js` suffix.
* Files with `.spec.js` suffix.

The `.test.js` / `.spec.js` files (or the `__tests__` folders) can be located at any depth under the `src` top level folder.

722
We recommend to put the test files (or `__tests__` folders) next to the code they are testing so that relative imports appear shorter. For example, if `App.test.js` and `App.js` are in the same folder, the test just needs to `import App from './App'` instead of a long relative path. Colocation also helps find tests more quickly in larger projects.
Dan Abramov's avatar
Dan Abramov committed
723
724
725
726
727

### Command Line Interface

When you run `npm test`, Jest will launch in the watch mode. Every time you save a file, it will re-run the tests, just like `npm start` recompiles the code.

728
The watcher includes an interactive command-line interface with the ability to run all tests, or focus on a search pattern. It is designed this way so that you can keep it open and enjoy fast re-runs. You can learn the commands from the “Watch Usage” note that the watcher prints after every run:
Dan Abramov's avatar
Dan Abramov committed
729
730
731
732
733

![Jest watch mode](http://facebook.github.io/jest/img/blog/15-watch.gif)

### Version Control Integration

734
By default, when you run `npm test`, Jest will only run the tests related to files changed since the last commit. This is an optimization designed to make your tests runs fast regardless of how many tests you have. However it assumes that you don’t often commit the code that doesn’t pass the tests.
Dan Abramov's avatar
Dan Abramov committed
735
736
737
738
739
740
741

Jest will always explicitly mention that it only ran tests related to the files changed since the last commit. You can also press `a` in the watch mode to force Jest to run all tests.

Jest will always run all tests on a [continuous integration](#continuous-integration) server or if the project is not inside a Git or Mercurial repository.

### Writing Tests

742
To create tests, add `it()` (or `test()`) blocks with the name of the test and its code. You may optionally wrap them in `describe()` blocks for logical grouping but this is neither required nor recommended.
Dan Abramov's avatar
Dan Abramov committed
743
744
745
746
747
748
749
750
751
752
753
754

Jest provides a built-in `expect()` global function for making assertions. A basic test could look like this:

```js
import sum from './sum';

it('sums numbers', () => {
  expect(sum(1, 2)).toEqual(3);
  expect(sum(2, 2)).toEqual(4);
});
```

Dan Abramov's avatar
Dan Abramov committed
755
All `expect()` matchers supported by Jest are [extensively documented here](http://facebook.github.io/jest/docs/api.html#expect-value).<br>
Dan Abramov's avatar
Dan Abramov committed
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
You can also use [`jest.fn()` and `expect(fn).toBeCalled()`](http://facebook.github.io/jest/docs/api.html#tobecalled) to create “spies” or mock functions.

### Testing Components

There is a broad spectrum of component testing techniques. They range from a “smoke test” verifying that a component renders without throwing, to shallow rendering and testing some of the output, to full rendering and testing component lifecycle and state changes.

Different projects choose different testing tradeoffs based on how often components change, and how much logic they contain. If you haven’t decided on a testing strategy yet, we recommend that you start with creating simple smoke tests for your components:

```js
import React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

it('renders without crashing', () => {
  const div = document.createElement('div');
  ReactDOM.render(<App />, div);
});
```

This test mounts a component and makes sure that it didn’t throw during rendering. Tests like this provide a lot value with very little effort so they are great as a starting point, and this is the test you will find in `src/App.test.js`.

When you encounter bugs caused by changing components, you will gain a deeper insight into which parts of them are worth testing in your application. This might be a good time to introduce more specific tests asserting specific expected output or behavior.

If you’d like to test components in isolation from the child components they render, we recommend using [`shallow()` rendering API](http://airbnb.io/enzyme/docs/api/shallow.html) from [Enzyme](http://airbnb.io/enzyme/). You can write a smoke test with it too:

```sh
npm install --save-dev enzyme react-addons-test-utils
```

```js
import React from 'react';
import { shallow } from 'enzyme';
import App from './App';

it('renders without crashing', () => {
  shallow(<App />);
});
```

Brian Ng's avatar
Brian Ng committed
795
Unlike the previous smoke test using `ReactDOM.render()`, this test only renders `<App>` and doesn’t go deeper. For example, even if `<App>` itself renders a `<Button>` that throws, this test will pass. Shallow rendering is great for isolated unit tests, but you may still want to create some full rendering tests to ensure the components integrate correctly. Enzyme supports [full rendering with `mount()`](http://airbnb.io/enzyme/docs/api/mount.html), and you can also use it for testing state changes and component lifecycle.
Dan Abramov's avatar
Dan Abramov committed
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813

You can read the [Enzyme documentation](http://airbnb.io/enzyme/) for more testing techniques. Enzyme documentation uses Chai and Sinon for assertions but you don’t have to use them because Jest provides built-in `expect()` and `jest.fn()` for spies.

Here is an example from Enzyme documentation that asserts specific output, rewritten to use Jest matchers:

```js
import React from 'react';
import { shallow } from 'enzyme';
import App from './App';

it('renders welcome message', () => {
  const wrapper = shallow(<App />);
  const welcome = <h2>Welcome to React</h2>;
  // expect(wrapper.contains(welcome)).to.equal(true);
  expect(wrapper.contains(welcome)).toEqual(true);
});
```

Dan Abramov's avatar
Dan Abramov committed
814
All Jest matchers are [extensively documented here](http://facebook.github.io/jest/docs/api.html#expect-value).<br>
Brian Ng's avatar
Brian Ng committed
815
Nevertheless you can use a third-party assertion library like [Chai](http://chaijs.com/) if you want to, as described below.
Dan Abramov's avatar
Dan Abramov committed
816
817
818
819
820
821
822
823
824
825
826
827
828
829

### Using Third Party Assertion Libraries

We recommend that you use `expect()` for assertions and `jest.fn()` for spies. If you are having issues with them please [file those against Jest](https://github.com/facebook/jest/issues/new), and we’ll fix them. We intend to keep making them better for React, supporting, for example, [pretty-printing React elements as JSX](https://github.com/facebook/jest/pull/1566).

However, if you are used to other libraries, such as [Chai](http://chaijs.com/) and [Sinon](http://sinonjs.org/), or if you have existing code using them that you’d like to port over, you can import them normally like this:

```js
import sinon from 'sinon';
import { expect } from 'chai';
```

and then use them in your tests like you normally do.

830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
### Initializing Test Environment

>Note: this feature is available with `react-scripts@0.4.0` and higher.

If your app uses a browser API that you need to mock in your tests or if you just need a global setup before running your tests, add a `src/setupTests.js` to your project. It will be automatically executed before running your tests.

For example:

#### `src/setupTests.js`
```js
const localStorageMock = {
  getItem: jest.fn(),
  setItem: jest.fn(),
  clear: jest.fn()
};
global.localStorage = localStorageMock
```

848
849
### Focusing and Excluding Tests

Dan Abramov's avatar
Dan Abramov committed
850
You can replace `it()` with `xit()` to temporarily exclude a test from being executed.<br>
851
852
Similarly, `fit()` lets you focus on a specific test without running any other tests.

Dan Abramov's avatar
Dan Abramov committed
853
854
### Coverage Reporting

Dan Abramov's avatar
Dan Abramov committed
855
Jest has an integrated coverage reporter that works well with ES6 and requires no configuration.<br>
Dan Abramov's avatar
Dan Abramov committed
856
857
858
859
860
861
862
863
Run `npm test -- --coverage` (note extra `--` in the middle) to include a coverage report like this:

![coverage report](http://i.imgur.com/5bFhnTS.png)

Note that tests run much slower with coverage so it is recommended to run it separately from your normal workflow.

### Continuous Integration

864
865
866
867
868
By default `npm test` runs the watcher with interactive CLI. However, you can force it to run tests once and finish the process by setting an environment variable called `CI`.

When creating a build of your application with `npm run build` linter warnings are not checked by default. Like `npm test`, you can force the build to perform a linter warning check by setting the environment variable `CI`. If any warnings are encountered then the build fails.

Popular CI servers already set the environment variable `CI` by default but you can do this yourself too:
Dan Abramov's avatar
Dan Abramov committed
869

870
871
872
### On CI servers
#### Travis CI

Brian Ng's avatar
Brian Ng committed
873
1. Following the [Travis Getting started](https://docs.travis-ci.com/user/getting-started/) guide for syncing your GitHub repository with Travis.  You may need to initialize some settings manually in your [profile](https://travis-ci.org/profile) page.
874
875
876
877
878
879
880
881
1. Add a `.travis.yml` file to your git repository.
```
language: node_js
node_js:
  - 4
  - 6
cache:
  directories:
882
883
    - node_modules
script:
884
  - npm test
885
  - npm run build
886
887
888
889
890
891
```
1. Trigger your first build with a git push.
1. [Customize your Travis CI Build](https://docs.travis-ci.com/user/customizing-the-build/) if needed.

### On your own environment
##### Windows (cmd.exe)
Dan Abramov's avatar
Dan Abramov committed
892
893
894
895
896

```cmd
set CI=true&&npm test
```

897
898
899
900
```cmd
set CI=true&&npm run build
```

Dan Abramov's avatar
Dan Abramov committed
901
902
(Note: the lack of whitespace is intentional.)

903
##### Linux, OS X (Bash)
Dan Abramov's avatar
Dan Abramov committed
904
905
906
907
908

```bash
CI=true npm test
```

909
910
911
912
913
914
915
```bash
CI=true npm run build
```

The test command will force Jest to run tests once instead of launching the watcher.

>  If you find yourself doing this often in development, please [file an issue](https://github.com/facebookincubator/create-react-app/issues/new) to tell us about your use case because we want to make watcher the best experience and are open to changing how it works to accommodate more workflows.
Dan Abramov's avatar
Dan Abramov committed
916

917
The build command will check for linter warnings and fail if any are found.
Dan Abramov's avatar
Dan Abramov committed
918
919
920
921
922
923
924
925
926
927
928
929
930

### Disabling jsdom

By default, the `package.json` of the generated project looks like this:

```js
  // ...
  "scripts": {
    // ...
    "test": "react-scripts test --env=jsdom"
  }
```

Dan Abramov's avatar
Dan Abramov committed
931
If you know that none of your tests depend on [jsdom](https://github.com/tmpvar/jsdom), you can safely remove `--env=jsdom`, and your tests will run faster.<br>
Dan Abramov's avatar
Dan Abramov committed
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
To help you make up your mind, here is a list of APIs that **need jsdom**:

* Any browser globals like `window` and `document`
* [`ReactDOM.render()`](https://facebook.github.io/react/docs/top-level-api.html#reactdom.render)
* [`TestUtils.renderIntoDocument()`](https://facebook.github.io/react/docs/test-utils.html#renderintodocument) ([a shortcut](https://github.com/facebook/react/blob/34761cf9a252964abfaab6faf74d473ad95d1f21/src/test/ReactTestUtils.js#L83-L91) for the above)
* [`mount()`](http://airbnb.io/enzyme/docs/api/mount.html) in [Enzyme](http://airbnb.io/enzyme/index.html)

In contrast, **jsdom is not needed** for the following APIs:

* [`TestUtils.createRenderer()`](https://facebook.github.io/react/docs/test-utils.html#shallow-rendering) (shallow rendering)
* [`shallow()`](http://airbnb.io/enzyme/docs/api/shallow.html) in [Enzyme](http://airbnb.io/enzyme/index.html)

Finally, jsdom is also not needed for [snapshot testing](http://facebook.github.io/jest/blog/2016/07/27/jest-14.html). Longer term, this is the direction we are interested in exploring, but snapshot testing is [not fully baked yet](https://github.com/facebookincubator/create-react-app/issues/372) so we don’t officially encourage its usage yet.

### Experimental Snapshot Testing

Snapshot testing is a new feature of Jest that automatically generates text snapshots of your components and saves them on the disk so if the UI output changes, you get notified without manually writing any assertions on the component output.

This feature is experimental and still [has major usage issues](https://github.com/facebookincubator/create-react-app/issues/372) so we only encourage you to use it if you like experimental technology. We intend to gradually improve it over time and eventually offer it as the default solution for testing React components, but this will take time. [Read more about snapshot testing.](http://facebook.github.io/jest/blog/2016/07/27/jest-14.html)

Orta's avatar
Orta committed
952
953
954
955
956
957
### Editor Integration

If you use [Visual Studio Code](https://code.visualstudio.com), there is a [Jest extension](https://github.com/orta/vscode-jest) which works with Create React App out of the box. This provides a lot of IDE-like features while using a text editor: showing the status of a test run with potential fail messages inline, starting and stopping the watcher automatically, and offering one-click snapshot updates. 

![VS Code Jest Preview](https://cloud.githubusercontent.com/assets/49038/20795349/a032308a-b7c8-11e6-9b34-7eeac781003f.png)

Dan Abramov's avatar
Dan Abramov committed
958
## Developing Components in Isolation
959

Alex Wilmer's avatar
Alex Wilmer committed
960
Usually, in an app, you have a lot of UI components, and each of them has many different states.
961
962
963
964
965
966
967
968
For an example, a simple button component could have following states:

* With a text label.
* With an emoji.
* In the disabled mode.

Usually, it’s hard to see these states without running a sample app or some examples.

Dan Abramov's avatar
Dan Abramov committed
969
Create React App doesn't include any tools for this by default, but you can easily add [React Storybook](https://github.com/kadirahq/react-storybook) to your project. **It is a third-party tool that lets you develop components and see all their states in isolation from your app**.
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997

![React Storybook Demo](http://i.imgur.com/7CIAWpB.gif)

You can also deploy your Storybook as a static app. This way, everyone in your team can view and review different states of UI components without starting a backend server or creating an account in your app.

**Here’s how to setup your app with Storybook:**

First, install the following npm package globally:

```sh
npm install -g getstorybook
```

Then, run the following command inside your app’s directory:

```sh
getstorybook
```

After that, follow the instructions on the screen.

Learn more about React Storybook:

* Screencast: [Getting Started with React Storybook](https://egghead.io/lessons/react-getting-started-with-react-storybook)
* [GitHub Repo](https://github.com/kadirahq/react-storybook)
* [Documentation](https://getstorybook.io/docs)
* [Snapshot Testing](https://github.com/kadirahq/storyshots) with React Storybook

Dan Abramov's avatar
Dan Abramov committed
998
999
1000
## Making a Progressive Web App

You can turn your React app into a [Progressive Web App](https://developers.google.com/web/progressive-web-apps/) by following the steps in [this repository](https://github.com/jeffposnick/create-react-pwa).
For faster browsing, not all history is shown. View entire blame