]> git.wincent.com - hextrapolate.git/blob - README-create-react-app.md
chore: nuke yarn.lock
[hextrapolate.git] / README-create-react-app.md
1 This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app).
2
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
6 ## Table of Contents
7
8 - [Updating to New Releases](#updating-to-new-releases)
9 - [Sending Feedback](#sending-feedback)
10 - [Folder Structure](#folder-structure)
11 - [Available Scripts](#available-scripts)
12   - [npm start](#npm-start)
13   - [npm test](#npm-test)
14   - [npm run build](#npm-run-build)
15   - [npm run eject](#npm-run-eject)
16 - [Supported Language Features and Polyfills](#supported-language-features-and-polyfills)
17 - [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor)
18 - [Displaying Lint Output in the Editor](#displaying-lint-output-in-the-editor)
19 - [Debugging in the Editor](#debugging-in-the-editor)
20 - [Changing the Page `<title>`](#changing-the-page-title)
21 - [Installing a Dependency](#installing-a-dependency)
22 - [Importing a Component](#importing-a-component)
23 - [Code Splitting](#code-splitting)
24 - [Adding a Stylesheet](#adding-a-stylesheet)
25 - [Post-Processing CSS](#post-processing-css)
26 - [Adding a CSS Preprocessor (Sass, Less etc.)](#adding-a-css-preprocessor-sass-less-etc)
27 - [Adding Images, Fonts, and Files](#adding-images-fonts-and-files)
28 - [Using the `public` Folder](#using-the-public-folder)
29   - [Changing the HTML](#changing-the-html)
30   - [Adding Assets Outside of the Module System](#adding-assets-outside-of-the-module-system)
31   - [When to Use the `public` Folder](#when-to-use-the-public-folder)
32 - [Using Global Variables](#using-global-variables)
33 - [Adding Bootstrap](#adding-bootstrap)
34   - [Using a Custom Theme](#using-a-custom-theme)
35 - [Adding Flow](#adding-flow)
36 - [Adding Custom Environment Variables](#adding-custom-environment-variables)
37   - [Referencing Environment Variables in the HTML](#referencing-environment-variables-in-the-html)
38   - [Adding Temporary Environment Variables In Your Shell](#adding-temporary-environment-variables-in-your-shell)
39   - [Adding Development Environment Variables In `.env`](#adding-development-environment-variables-in-env)
40 - [Can I Use Decorators?](#can-i-use-decorators)
41 - [Integrating with an API Backend](#integrating-with-an-api-backend)
42   - [Node](#node)
43   - [Ruby on Rails](#ruby-on-rails)
44 - [Proxying API Requests in Development](#proxying-api-requests-in-development)
45   - ["Invalid Host Header" Errors After Configuring Proxy](#invalid-host-header-errors-after-configuring-proxy)
46   - [Configuring the Proxy Manually](#configuring-the-proxy-manually)
47 - [Using HTTPS in Development](#using-https-in-development)
48 - [Generating Dynamic `<meta>` Tags on the Server](#generating-dynamic-meta-tags-on-the-server)
49 - [Pre-Rendering into Static HTML Files](#pre-rendering-into-static-html-files)
50 - [Injecting Data from the Server into the Page](#injecting-data-from-the-server-into-the-page)
51 - [Running Tests](#running-tests)
52   - [Filename Conventions](#filename-conventions)
53   - [Command Line Interface](#command-line-interface)
54   - [Version Control Integration](#version-control-integration)
55   - [Writing Tests](#writing-tests)
56   - [Testing Components](#testing-components)
57   - [Using Third Party Assertion Libraries](#using-third-party-assertion-libraries)
58   - [Initializing Test Environment](#initializing-test-environment)
59   - [Focusing and Excluding Tests](#focusing-and-excluding-tests)
60   - [Coverage Reporting](#coverage-reporting)
61   - [Continuous Integration](#continuous-integration)
62   - [Disabling jsdom](#disabling-jsdom)
63   - [Snapshot Testing](#snapshot-testing)
64   - [Editor Integration](#editor-integration)
65 - [Making a Progressive Web App](#making-a-progressive-web-app)
66   - [Offline-First Considerations](#offline-first-considerations)
67   - [Progressive Web App Metadata](#progressive-web-app-metadata)
68 - [Deployment](#deployment)
69   - [Static Server](#static-server)
70   - [Other Solutions](#other-solutions)
71   - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing)
72   - [Building for Relative Paths](#building-for-relative-paths)
73   - [Azure](#azure)
74   - [Firebase](#firebase)
75   - [GitHub Pages](#github-pages)
76   - [Heroku](#heroku)
77   - [Modulus](#modulus)
78   - [Netlify](#netlify)
79   - [Now](#now)
80   - [S3 and CloudFront](#s3-and-cloudfront)
81   - [Surge](#surge)
82 - [Advanced Configuration](#advanced-configuration)
83 - [Troubleshooting](#troubleshooting)
84   - [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes)
85   - [`npm test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra)
86   - [`npm run build` silently fails](#npm-run-build-silently-fails)
87   - [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku)
88   - [Moment.js locales are missing](#momentjs-locales-are-missing)
89 - [Something Missing?](#something-missing)
90
91 ## Updating to New Releases
92
93 Create React App is divided into two packages:
94
95 * `create-react-app` is a global command-line utility that you use to create new projects.
96 * `react-scripts` is a development dependency in the generated projects (including this one).
97
98 You almost never need to update `create-react-app` itself: it delegates all the setup to `react-scripts`.
99
100 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.
101
102 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.
103
104 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.
105
106 We commit to keeping the breaking changes minimal so you can upgrade `react-scripts` painlessly.
107
108 ## Sending Feedback
109
110 We are always open to [your feedback](https://github.com/facebookincubator/create-react-app/issues).
111
112 ## Folder Structure
113
114 After creation, your project should look like this:
115
116 ```
117 my-app/
118   README.md
119   node_modules/
120   package.json
121   public/
122     index.html
123     favicon.ico
124   src/
125     App.css
126     App.js
127     App.test.js
128     index.css
129     index.js
130     logo.svg
131 ```
132
133 For the project to build, **these files must exist with exact filenames**:
134
135 * `public/index.html` is the page template;
136 * `src/index.js` is the JavaScript entry point.
137
138 You can delete or rename the other files.
139
140 You may create subdirectories inside `src`. For faster rebuilds, only files inside `src` are processed by Webpack.<br>
141 You need to **put any JS and CSS files inside `src`**, or Webpack won’t see them.
142
143 Only files inside `public` can be used from `public/index.html`.<br>
144 Read instructions below for using assets from JavaScript and HTML.
145
146 You can, however, create more top-level directories.<br>
147 They will not be included in the production build so you can use them for things like documentation.
148
149 ## Available Scripts
150
151 In the project directory, you can run:
152
153 ### `npm start`
154
155 Runs the app in the development mode.<br>
156 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
157
158 The page will reload if you make edits.<br>
159 You will also see any lint errors in the console.
160
161 ### `npm test`
162
163 Launches the test runner in the interactive watch mode.<br>
164 See the section about [running tests](#running-tests) for more information.
165
166 ### `npm run build`
167
168 Builds the app for production to the `build` folder.<br>
169 It correctly bundles React in production mode and optimizes the build for the best performance.
170
171 The build is minified and the filenames include the hashes.<br>
172 Your app is ready to be deployed!
173
174 See the section about [deployment](#deployment) for more information.
175
176 ### `npm run eject`
177
178 **Note: this is a one-way operation. Once you `eject`, you can’t go back!**
179
180 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.
181
182 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.
183
184 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.
185
186 ## Supported Language Features and Polyfills
187
188 This project supports a superset of the latest JavaScript standard.<br>
189 In addition to [ES6](https://github.com/lukehoban/es6features) syntax features, it also supports:
190
191 * [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016).
192 * [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017).
193 * [Object Rest/Spread Properties](https://github.com/sebmarkbage/ecmascript-rest-spread) (stage 3 proposal).
194 * [Dynamic import()](https://github.com/tc39/proposal-dynamic-import) (stage 3 proposal)
195 * [Class Fields and Static Properties](https://github.com/tc39/proposal-class-public-fields) (stage 2 proposal).
196 * [JSX](https://facebook.github.io/react/docs/introducing-jsx.html) and [Flow](https://flowtype.org/) syntax.
197
198 Learn more about [different proposal stages](https://babeljs.io/docs/plugins/#presets-stage-x-experimental-presets-).
199
200 While we recommend to use experimental proposals with some caution, Facebook heavily uses these features in the product code, so we intend to provide [codemods](https://medium.com/@cpojer/effective-javascript-codemods-5a6686bb46fb) if any of these proposals change in the future.
201
202 Note that **the project only includes a few ES6 [polyfills](https://en.wikipedia.org/wiki/Polyfill)**:
203
204 * [`Object.assign()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) via [`object-assign`](https://github.com/sindresorhus/object-assign).
205 * [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) via [`promise`](https://github.com/then/promise).
206 * [`fetch()`](https://developer.mozilla.org/en/docs/Web/API/Fetch_API) via [`whatwg-fetch`](https://github.com/github/fetch).
207
208 If you use any other ES6+ features that need **runtime support** (such as `Array.from()` or `Symbol`), make sure you are including the appropriate polyfills manually, or that the browsers you are targeting already support them.
209
210 ## Syntax Highlighting in the Editor
211
212 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.
213
214 ## Displaying Lint Output in the Editor
215
216 >Note: this feature is available with `react-scripts@0.2.0` and higher.<br>
217 >It also only works with npm 3 or higher.
218
219 Some editors, including Sublime Text, Atom, and Visual Studio Code, provide plugins for ESLint.
220
221 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.
222
223 You would need to install an ESLint plugin for your editor first. Then, add a file called `.eslintrc` to the project root:
224
225 ```js
226 {
227   "extends": "react-app"
228 }
229 ```
230
231 Now your editor should report the linting warnings.
232
233 Note that even if you edit your `.eslintrc` file further, these changes will **only affect the editor integration**. They won’t affect the terminal and in-browser lint output. This is because Create React App intentionally provides a minimal set of rules that find common mistakes.
234
235 If you want to enforce a coding style for your project, consider using [Prettier](https://github.com/jlongster/prettier) instead of ESLint style rules.
236
237 ## Debugging in the Editor
238
239 **This feature is currently only supported by [Visual Studio Code](https://code.visualstudio.com) editor.**
240
241 Visual Studio Code supports debugging out of the box with Create React App. This enables you as a developer to write and debug your React code without leaving the editor, and most importantly it enables you to have a continuous development workflow, where context switching is minimal, as you don’t have to switch between tools.
242
243 You would need to have the latest version of [VS Code](https://code.visualstudio.com) and VS Code [Chrome Debugger Extension](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) installed.
244
245 Then add the block below to your `launch.json` file and put it inside the `.vscode` folder in your app’s root directory.
246
247 ```json
248 {
249   "version": "0.2.0",
250   "configurations": [{
251     "name": "Chrome",
252     "type": "chrome",
253     "request": "launch",
254     "url": "http://localhost:3000",
255     "webRoot": "${workspaceRoot}/src",
256     "userDataDir": "${workspaceRoot}/.vscode/chrome",
257     "sourceMapPathOverrides": {
258       "webpack:///src/*": "${webRoot}/*"
259     }
260   }]
261 }
262 ```
263
264 Start your app by running `npm start`, and start debugging in VS Code by pressing `F5` or by clicking the green debug icon. You can now write code, set breakpoints, make changes to the code, and debug your newly modified code—all from your editor.
265
266 ## Changing the Page `<title>`
267
268 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.
269
270 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.
271
272 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.
273
274 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). Alternatively, you can pre-build each page as a static HTML file which then loads the JavaScript bundle, which is covered [here](#pre-rendering-into-static-html-files).
275
276 ## Installing a Dependency
277
278 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`:
279
280 ```
281 npm install --save <library-name>
282 ```
283
284 ## Importing a Component
285
286 This project setup supports ES6 modules thanks to Babel.<br>
287 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.
288
289 For example:
290
291 ### `Button.js`
292
293 ```js
294 import React, { Component } from 'react';
295
296 class Button extends Component {
297   render() {
298     // ...
299   }
300 }
301
302 export default Button; // Don’t forget to use export default!
303 ```
304
305 ### `DangerButton.js`
306
307
308 ```js
309 import React, { Component } from 'react';
310 import Button from './Button'; // Import a component from another file
311
312 class DangerButton extends Component {
313   render() {
314     return <Button color="red" />;
315   }
316 }
317
318 export default DangerButton;
319 ```
320
321 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.
322
323 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'`.
324
325 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.
326
327 Learn more about ES6 modules:
328
329 * [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)
330 * [Exploring ES6: Modules](http://exploringjs.com/es6/ch_modules.html)
331 * [Understanding ES6: Modules](https://leanpub.com/understandinges6/read#leanpub-auto-encapsulating-code-with-modules)
332
333 ## Code Splitting
334
335 Instead of downloading the entire app before users can use it, code splitting allows you to split your code into small chunks which you can then load on demand.
336
337 This project setup supports code splitting via [dynamic `import()`](http://2ality.com/2017/01/import-operator.html#loading-code-on-demand). Its [proposal](https://github.com/tc39/proposal-dynamic-import) is in stage 3. The `import()` function-like form takes the module name as an argument and returns a [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) which always resolves to the namespace object of the module.
338
339 Here is an example:
340
341 ### `moduleA.js`
342
343 ```js
344 const moduleA = 'Hello';
345
346 export { moduleA };
347 ```
348 ### `App.js`
349
350 ```js
351 import React, { Component } from 'react';
352
353 class App extends Component {
354   handleClick = () => {
355     import('./moduleA')
356       .then(({ moduleA }) => {
357         // Use moduleA
358       })
359       .catch(err => {
360         // Handle failure
361       });
362   };
363
364   render() {
365     return (
366       <div>
367         <button onClick={this.handleClick}>Load</button>
368       </div>
369     );
370   }
371 }
372
373 export default App;
374 ```
375
376 This will make `moduleA.js` and all its unique dependencies as a separate chunk that only loads after the user clicks the 'Load' button.
377
378 You can also use it with `async` / `await` syntax if you prefer it.
379
380 ## Adding a Stylesheet
381
382 This project setup uses [Webpack](https://webpack.js.org/) 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**:
383
384 ### `Button.css`
385
386 ```css
387 .Button {
388   padding: 20px;
389 }
390 ```
391
392 ### `Button.js`
393
394 ```js
395 import React, { Component } from 'react';
396 import './Button.css'; // Tell Webpack that Button.js uses these styles
397
398 class Button extends Component {
399   render() {
400     // You can use them as regular CSS styles
401     return <div className="Button" />;
402   }
403 }
404 ```
405
406 **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.
407
408 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.
409
410 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.
411
412 ## Post-Processing CSS
413
414 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.
415
416 For example, this:
417
418 ```css
419 .App {
420   display: flex;
421   flex-direction: row;
422   align-items: center;
423 }
424 ```
425
426 becomes this:
427
428 ```css
429 .App {
430   display: -webkit-box;
431   display: -ms-flexbox;
432   display: flex;
433   -webkit-box-orient: horizontal;
434   -webkit-box-direction: normal;
435       -ms-flex-direction: row;
436           flex-direction: row;
437   -webkit-box-align: center;
438       -ms-flex-align: center;
439           align-items: center;
440 }
441 ```
442
443 If you need to disable autoprefixing for some reason, [follow this section](https://github.com/postcss/autoprefixer#disabling).
444
445 ## Adding a CSS Preprocessor (Sass, Less etc.)
446
447 Generally, we recommend that you don’t reuse the same CSS classes across different components. For example, instead of using a `.Button` CSS class in `<AcceptButton>` and `<RejectButton>` components, we recommend creating a `<Button>` component with its own `.Button` styles, that both `<AcceptButton>` and `<RejectButton>` can render (but [not inherit](https://facebook.github.io/react/docs/composition-vs-inheritance.html)).
448
449 Following this rule often makes CSS preprocessors less useful, as features like mixins and nesting are replaced by component composition. You can, however, integrate a CSS preprocessor if you find it valuable. In this walkthrough, we will be using Sass, but you can also use Less, or another alternative.
450
451 First, let’s install the command-line interface for Sass:
452
453 ```
454 npm install node-sass-chokidar --save-dev
455 ```
456 Then in `package.json`, add the following lines to `scripts`:
457
458 ```diff
459    "scripts": {
460 +    "build-css": "node-sass-chokidar src/ -o src/",
461 +    "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive",
462      "start": "react-scripts start",
463      "build": "react-scripts build",
464      "test": "react-scripts test --env=jsdom",
465 ```
466
467 >Note: To use a different preprocessor, replace `build-css` and `watch-css` commands according to your preprocessor’s documentation.
468
469 Now you can rename `src/App.css` to `src/App.scss` and run `npm run watch-css`. The watcher will find every Sass file in `src` subdirectories, and create a corresponding CSS file next to it, in our case overwriting `src/App.css`. Since `src/App.js` still imports `src/App.css`, the styles become a part of your application. You can now edit `src/App.scss`, and `src/App.css` will be regenerated.
470
471 To share variables between Sass files, you can use Sass imports. For example, `src/App.scss` and other component style files could include `@import "./shared.scss";` with variable definitions.
472
473 To enable importing files without using relative paths, you can add the  `--include-path` option to the command in `package.json`.
474
475 ```
476 "build-css": "node-sass-chokidar --include-path ./src --include-path ./node_modules src/ -o src/",
477 "watch-css": "npm run build-css && node-sass-chokidar --include-path ./src --include-path ./node_modules src/ -o src/ --watch --recursive",
478 ```
479
480 This will allow you to do imports like
481
482 ```scss
483 @import 'styles/_colors.scss'; // assuming a styles directory under src/
484 @import 'nprogress/nprogress'; // importing a css file from the nprogress node module
485 ```
486
487 At this point you might want to remove all CSS files from the source control, and add `src/**/*.css` to your `.gitignore` file. It is generally a good practice to keep the build products outside of the source control.
488
489 As a final step, you may find it convenient to run `watch-css` automatically with `npm start`, and run `build-css` as a part of `npm run build`. You can use the `&&` operator to execute two scripts sequentially. However, there is no cross-platform way to run two scripts in parallel, so we will install a package for this:
490
491 ```
492 npm install --save-dev npm-run-all
493 ```
494
495 Then we can change `start` and `build` scripts to include the CSS preprocessor commands:
496
497 ```diff
498    "scripts": {
499      "build-css": "node-sass-chokidar src/ -o src/",
500      "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive",
501 -    "start": "react-scripts start",
502 -    "build": "react-scripts build",
503 +    "start-js": "react-scripts start",
504 +    "start": "npm-run-all -p watch-css start-js",
505 +    "build": "npm run build-css && react-scripts build",
506      "test": "react-scripts test --env=jsdom",
507      "eject": "react-scripts eject"
508    }
509 ```
510
511 Now running `npm start` and `npm run build` also builds Sass files.
512
513 **Why `node-sass-chokidar`?**
514
515 `node-sass` has been reported as having the following issues:
516
517 - `node-sass --watch` has been reported to have *performance issues* in certain conditions when used in a virtual machine or with docker.
518
519 - Infinite styles compiling [#1939](https://github.com/facebookincubator/create-react-app/issues/1939)
520
521 - `node-sass` has been reported as having issues with detecting new files in a directory [#1891](https://github.com/sass/node-sass/issues/1891)
522
523  `node-sass-chokidar` is used here as it addresses these issues.
524
525 ## Adding Images, Fonts, and Files
526
527 With Webpack, using static assets like images and fonts works similarly to CSS.
528
529 You can **`import` a file right in a JavaScript module**. This tells Webpack to include that file in the bundle. Unlike CSS imports, importing a file gives you a string value. This value is the final path you can reference in your code, e.g. as the `src` attribute of an image or the `href` of a link to a PDF.
530
531 To reduce the number of requests to the server, importing images that are less than 10,000 bytes returns a [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) instead of a path. This applies to the following file extensions: bmp, gif, jpg, jpeg, and png. SVG files are excluded due to [#1153](https://github.com/facebookincubator/create-react-app/issues/1153).
532
533 Here is an example:
534
535 ```js
536 import React from 'react';
537 import logo from './logo.png'; // Tell Webpack this JS file uses this image
538
539 console.log(logo); // /logo.84287d09.png
540
541 function Header() {
542   // Import result is the URL of your image
543   return <img src={logo} alt="Logo" />;
544 }
545
546 export default Header;
547 ```
548
549 This ensures that when the project is built, Webpack will correctly move the images into the build folder, and provide us with correct paths.
550
551 This works in CSS too:
552
553 ```css
554 .Logo {
555   background-image: url(./logo.png);
556 }
557 ```
558
559 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.
560
561 Please be advised that this is also a custom feature of Webpack.
562
563 **It is not required for React** but many people enjoy it (and React Native uses a similar mechanism for images).<br>
564 An alternative way of handling static assets is described in the next section.
565
566 ## Using the `public` Folder
567
568 >Note: this feature is available with `react-scripts@0.5.0` and higher.
569
570 ### Changing the HTML
571
572 The `public` folder contains the HTML file so you can tweak it, for example, to [set the page title](#changing-the-page-title).
573 The `<script>` tag with the compiled code will be added to it automatically during the build process.
574
575 ### Adding Assets Outside of the Module System
576
577 You can also add other assets to the `public` folder.
578
579 Note that we normally encourage you to `import` assets in JavaScript files instead.
580 For example, see the sections on [adding a stylesheet](#adding-a-stylesheet) and [adding images and fonts](#adding-images-fonts-and-files).
581 This mechanism provides a number of benefits:
582
583 * Scripts and stylesheets get minified and bundled together to avoid extra network requests.
584 * Missing files cause compilation errors instead of 404 errors for your users.
585 * Result filenames include content hashes so you don’t need to worry about browsers caching their old versions.
586
587 However there is an **escape hatch** that you can use to add an asset outside of the module system.
588
589 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`.
590
591 Inside `index.html`, you can use it like this:
592
593 ```html
594 <link rel="shortcut icon" href="%PUBLIC_URL%/favicon.ico">
595 ```
596
597 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.
598
599 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.
600
601 In JavaScript code, you can use `process.env.PUBLIC_URL` for similar purposes:
602
603 ```js
604 render() {
605   // Note: this is an escape hatch and should be used sparingly!
606   // Normally we recommend using `import` for getting asset URLs
607   // as described in “Adding Images and Fonts” above this section.
608   return <img src={process.env.PUBLIC_URL + '/img/logo.png'} />;
609 }
610 ```
611
612 Keep in mind the downsides of this approach:
613
614 * None of the files in `public` folder get post-processed or minified.
615 * Missing files will not be called at compilation time, and will cause 404 errors for your users.
616 * Result filenames won’t include content hashes so you’ll need to add query arguments or rename them every time they change.
617
618 ### When to Use the `public` Folder
619
620 Normally we recommend importing [stylesheets](#adding-a-stylesheet), [images, and fonts](#adding-images-fonts-and-files) from JavaScript.
621 The `public` folder is useful as a workaround for a number of less common cases:
622
623 * 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).
624 * You have thousands of images and need to dynamically reference their paths.
625 * You want to include a small script like [`pace.js`](http://github.hubspot.com/pace/docs/welcome/) outside of the bundled code.
626 * Some library may be incompatible with Webpack and you have no other option but to include it as a `<script>` tag.
627
628 Note that if you add a `<script>` that declares global variables, you also need to read the next section on using them.
629
630 ## Using Global Variables
631
632 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.
633
634 You can avoid this by reading the global variable explicitly from the `window` object, for example:
635
636 ```js
637 const $ = window.$;
638 ```
639
640 This makes it obvious you are using a global variable intentionally rather than because of a typo.
641
642 Alternatively, you can force the linter to ignore any line by adding `// eslint-disable-line` after it.
643
644 ## Adding Bootstrap
645
646 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:
647
648 Install React Bootstrap and Bootstrap from npm. React Bootstrap does not include Bootstrap CSS so this needs to be installed as well:
649
650 ```
651 npm install react-bootstrap --save
652 npm install bootstrap@3 --save
653 ```
654
655 Import Bootstrap CSS and optionally Bootstrap theme CSS in the beginning of your ```src/index.js``` file:
656
657 ```js
658 import 'bootstrap/dist/css/bootstrap.css';
659 import 'bootstrap/dist/css/bootstrap-theme.css';
660 // Put any other imports below so that CSS from your
661 // components takes precedence over default styles.
662 ```
663
664 Import required React Bootstrap components within ```src/App.js``` file or your custom component files:
665
666 ```js
667 import { Navbar, Jumbotron, Button } from 'react-bootstrap';
668 ```
669
670 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.
671
672 ### Using a Custom Theme
673
674 Sometimes you might need to tweak the visual styles of Bootstrap (or equivalent package).<br>
675 We suggest the following approach:
676
677 * Create a new package that depends on the package you wish to customize, e.g. Bootstrap.
678 * Add the necessary build steps to tweak the theme, and publish your package on npm.
679 * Install your own theme npm package as a dependency of your app.
680
681 Here is an example of adding a [customized Bootstrap](https://medium.com/@tacomanator/customizing-create-react-app-aa9ffb88165) that follows these steps.
682
683 ## Adding Flow
684
685 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.
686
687 Recent versions of [Flow](http://flowtype.org/) work with Create React App projects out of the box.
688
689 To add Flow to a Create React App project, follow these steps:
690
691 1. Run `npm install --save-dev flow-bin` (or `yarn add --dev flow-bin`).
692 2. Add `"flow": "flow"` to the `scripts` section of your `package.json`.
693 3. Run `npm run flow -- init` (or `yarn flow -- init`) to create a [`.flowconfig` file](https://flowtype.org/docs/advanced-configuration.html) in the root directory.
694 4. Add `// @flow` to any files you want to type check (for example, to `src/App.js`).
695
696 Now you can run `npm run flow` (or `yarn flow`) to check the files for type errors.
697 You can optionally use an IDE like [Nuclide](https://nuclide.io/docs/languages/flow/) for a better integrated experience.
698 In the future we plan to integrate it into Create React App even more closely.
699
700 To learn more about Flow, check out [its documentation](https://flowtype.org/).
701
702 ## Adding Custom Environment Variables
703
704 >Note: this feature is available with `react-scripts@0.2.3` and higher.
705
706 Your project can consume variables declared in your environment as if they were declared locally in your JS files. By
707 default you will have `NODE_ENV` defined for you, and any other environment variables starting with
708 `REACT_APP_`.
709
710 **The environment variables are embedded during the build time**. Since Create React App produces a static HTML/CSS/JS bundle, it can’t possibly read them at runtime. To read them at runtime, you would need to load HTML into memory on the server and replace placeholders in runtime, just like [described here](#injecting-data-from-the-server-into-the-page). Alternatively you can rebuild the app on the server anytime you change them.
711
712 >Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid accidentally [exposing a private key on the machine that could have the same name](https://github.com/facebookincubator/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running.
713
714 These environment variables will be defined for you on `process.env`. For example, having an environment
715 variable named `REACT_APP_SECRET_CODE` will be exposed in your JS as `process.env.REACT_APP_SECRET_CODE`.
716
717 There is also a special built-in environment variable called `NODE_ENV`. You can read it from `process.env.NODE_ENV`. When you run `npm start`, it is always equal to `'development'`, when you run `npm test` it is always equal to `'test'`, and when you run `npm run build` to make a production bundle, it is always equal to `'production'`. **You cannot override `NODE_ENV` manually.** This prevents developers from accidentally deploying a slow development build to production.
718
719 These environment variables can be useful for displaying information conditionally based on where the project is
720 deployed or consuming sensitive data that lives outside of version control.
721
722 First, you need to have environment variables defined. For example, let’s say you wanted to consume a secret defined
723 in the environment inside a `<form>`:
724
725 ```jsx
726 render() {
727   return (
728     <div>
729       <small>You are running this application in <b>{process.env.NODE_ENV}</b> mode.</small>
730       <form>
731         <input type="hidden" defaultValue={process.env.REACT_APP_SECRET_CODE} />
732       </form>
733     </div>
734   );
735 }
736 ```
737
738 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.
739
740 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`:
741
742 ```html
743 <div>
744   <small>You are running this application in <b>development</b> mode.</small>
745   <form>
746     <input type="hidden" value="abcdef" />
747   </form>
748 </div>
749 ```
750
751 The above form is looking for a variable called `REACT_APP_SECRET_CODE` from the environment. In order to consume this
752 value, we need to have it defined in the environment. This can be done using two ways: either in your shell or in
753 a `.env` file. Both of these ways are described in the next few sections.
754
755 Having access to the `NODE_ENV` is also useful for performing actions conditionally:
756
757 ```js
758 if (process.env.NODE_ENV !== 'production') {
759   analytics.disable();
760 }
761 ```
762
763 When you compile the app with `npm run build`, the minification step will strip out this condition, and the resulting bundle will be smaller.
764
765 ### Referencing Environment Variables in the HTML
766
767 >Note: this feature is available with `react-scripts@0.9.0` and higher.
768
769 You can also access the environment variables starting with `REACT_APP_` in the `public/index.html`. For example:
770
771 ```html
772 <title>%REACT_APP_WEBSITE_NAME%</title>
773 ```
774
775 Note that the caveats from the above section apply:
776
777 * Apart from a few built-in variables (`NODE_ENV` and `PUBLIC_URL`), variable names must start with `REACT_APP_` to work.
778 * The environment variables are injected at build time. If you need to inject them at runtime, [follow this approach instead](#generating-dynamic-meta-tags-on-the-server).
779
780 ### Adding Temporary Environment Variables In Your Shell
781
782 Defining environment variables can vary between OSes. It’s also important to know that this manner is temporary for the
783 life of the shell session.
784
785 #### Windows (cmd.exe)
786
787 ```cmd
788 set REACT_APP_SECRET_CODE=abcdef&&npm start
789 ```
790
791 (Note: the lack of whitespace is intentional.)
792
793 #### Linux, macOS (Bash)
794
795 ```bash
796 REACT_APP_SECRET_CODE=abcdef npm start
797 ```
798
799 ### Adding Development Environment Variables In `.env`
800
801 >Note: this feature is available with `react-scripts@0.5.0` and higher.
802
803 To define permanent environment variables, create a file called `.env` in the root of your project:
804
805 ```
806 REACT_APP_SECRET_CODE=abcdef
807 ```
808
809 `.env` files **should be** checked into source control (with the exclusion of `.env*.local`).
810
811 #### What other `.env` files are can be used?
812
813 >Note: this feature is **available with `react-scripts@1.0.0` and higher**.
814
815 * `.env`: Default.
816 * `.env.local`: Local overrides. **This file is loaded for all environments except test.**
817 * `.env.development`, `.env.test`, `.env.production`: Environment-specific settings.
818 * `.env.development.local`, `.env.test.local`, `.env.production.local`: Local overrides of environment-specific settings.
819
820 Files on the left have more priority than files on the right:
821
822 * `npm start`: `.env.development.local`, `.env.development`, `.env.local`, `.env`
823 * `npm run build`: `.env.production.local`, `.env.production`, `.env.local`, `.env`
824 * `npm test`: `.env.test.local`, `.env.test`, `.env` (note `.env.local` is missing)
825
826 These variables will act as the defaults if the machine does not explicitly set them.<br>
827 Please refer to the [dotenv documentation](https://github.com/motdotla/dotenv) for more details.
828
829 >Note: If you are defining environment variables for development, your CI and/or hosting platform will most likely need
830 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).
831
832 ## Can I Use Decorators?
833
834 Many popular libraries use [decorators](https://medium.com/google-developers/exploring-es7-decorators-76ecb65fb841) in their documentation.<br>
835 Create React App doesn’t support decorator syntax at the moment because:
836
837 * It is an experimental proposal and is subject to change.
838 * The current specification version is not officially supported by Babel.
839 * If the specification changes, we won’t be able to write a codemod because we don’t use them internally at Facebook.
840
841 However in many cases you can rewrite decorator-based code without decorators just as fine.<br>
842 Please refer to these two threads for reference:
843
844 * [#214](https://github.com/facebookincubator/create-react-app/issues/214)
845 * [#411](https://github.com/facebookincubator/create-react-app/issues/411)
846
847 Create React App will add decorator support when the specification advances to a stable stage.
848
849 ## Integrating with an API Backend
850
851 These tutorials will help you to integrate your app with an API backend running on another port,
852 using `fetch()` to access it.
853
854 ### Node
855 Check out [this tutorial](https://www.fullstackreact.com/articles/using-create-react-app-with-a-server/).
856 You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo).
857
858 ### Ruby on Rails
859
860 Check out [this tutorial](https://www.fullstackreact.com/articles/how-to-get-create-react-app-to-work-with-your-rails-api/).
861 You can find the companion GitHub repository [here](https://github.com/fullstackreact/food-lookup-demo-rails).
862
863 ## Proxying API Requests in Development
864
865 >Note: this feature is available with `react-scripts@0.2.3` and higher.
866
867 People often serve the front-end React app from the same host and port as their backend implementation.<br>
868 For example, a production setup might look like this after the app is deployed:
869
870 ```
871 /             - static server returns index.html with React app
872 /todos        - static server returns index.html with React app
873 /api/todos    - server handles any /api/* requests using the backend implementation
874 ```
875
876 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.
877
878 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:
879
880 ```js
881   "proxy": "http://localhost:4000",
882 ```
883
884 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.
885
886 Conveniently, this avoids [CORS issues](http://stackoverflow.com/questions/21854516/understanding-ajax-cors-and-security-considerations) and error messages like this in development:
887
888 ```
889 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.
890 ```
891
892 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`.
893
894 The `proxy` option supports HTTP, HTTPS and WebSocket connections.<br>
895 If the `proxy` option is **not** flexible enough for you, alternatively you can:
896
897 * [Configure the proxy yourself](#configuring-the-proxy-manually)
898 * Enable CORS on your server ([here’s how to do it for Express](http://enable-cors.org/server_expressjs.html)).
899 * Use [environment variables](#adding-custom-environment-variables) to inject the right server host and port into your app.
900
901 ### "Invalid Host Header" Errors After Configuring Proxy
902
903 When you enable the `proxy` option, you opt into a more strict set of host checks. This is necessary because leaving the backend open to remote hosts makes your computer vulnerable to DNS rebinding attacks. The issue is explained in [this article](https://medium.com/webpack/webpack-dev-server-middleware-security-issues-1489d950874a) and [this issue](https://github.com/webpack/webpack-dev-server/issues/887).
904
905 This shouldn’t affect you when developing on `localhost`, but if you develop remotely like [described here](https://github.com/facebookincubator/create-react-app/issues/2271), you will see this error in the browser after enabling the `proxy` option:
906
907 >Invalid Host header
908
909 To work around it, you can specify your public development host in a file called `.env.development` in the root of your project:
910
911 ```
912 HOST=mypublicdevhost.com
913 ```
914
915 If you restart the development server now and load the app from the specified host, it should work.
916
917 If you are still having issues or if you’re using a more exotic environment like a cloud editor, you can bypass the host check completely by adding a line to `.env.development.local`. **Note that this is dangerous and exposes your machine to remote code execution from malicious websites:**
918
919 ```
920 # NOTE: THIS IS DANGEROUS!
921 # It exposes your machine to attacks from the websites you visit.
922 DANGEROUSLY_DISABLE_HOST_CHECK=true
923 ```
924
925 We don’t recommend this approach.
926
927 ### Configuring the Proxy Manually
928
929 >Note: this feature is available with `react-scripts@1.0.0` and higher.
930
931 If the `proxy` option is **not** flexible enough for you, you can specify an object in the following form (in `package.json`).<br>
932 You may also specify any configuration value [`http-proxy-middleware`](https://github.com/chimurai/http-proxy-middleware#options) or [`http-proxy`](https://github.com/nodejitsu/node-http-proxy#options) supports.
933 ```js
934 {
935   // ...
936   "proxy": {
937     "/api": {
938       "target": "<url>",
939       "ws": true
940       // ...
941     }
942   }
943   // ...
944 }
945 ```
946
947 All requests matching this path will be proxies, no exceptions. This includes requests for `text/html`, which the standard `proxy` option does not proxy.
948
949 If you need to specify multiple proxies, you may do so by specifying additional entries.
950 You may also narrow down matches using `*` and/or `**`, to match the path exactly or any subpath.
951 ```js
952 {
953   // ...
954   "proxy": {
955     // Matches any request starting with /api
956     "/api": {
957       "target": "<url_1>",
958       "ws": true
959       // ...
960     },
961     // Matches any request starting with /foo
962     "/foo": {
963       "target": "<url_2>",
964       "ssl": true,
965       "pathRewrite": {
966         "^/foo": "/foo/beta"
967       }
968       // ...
969     },
970     // Matches /bar/abc.html but not /bar/sub/def.html
971     "/bar/*.html": {
972       "target": "<url_3>",
973       // ...
974     },
975     // Matches /bar/abc.html and /bar/sub/def.html
976     "/baz/**/*.html": {
977       "target": "<url_4>"
978       // ...
979     }
980   }
981   // ...
982 }
983 ```
984
985 ## Using HTTPS in Development
986
987 >Note: this feature is available with `react-scripts@0.4.0` and higher.
988
989 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.
990
991 To do this, set the `HTTPS` environment variable to `true`, then start the dev server as usual with `npm start`:
992
993 #### Windows (cmd.exe)
994
995 ```cmd
996 set HTTPS=true&&npm start
997 ```
998
999 (Note: the lack of whitespace is intentional.)
1000
1001 #### Linux, macOS (Bash)
1002
1003 ```bash
1004 HTTPS=true npm start
1005 ```
1006
1007 Note that the server will use a self-signed certificate, so your web browser will almost definitely display a warning upon accessing the page.
1008
1009 ## Generating Dynamic `<meta>` Tags on the Server
1010
1011 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:
1012
1013 ```html
1014 <!doctype html>
1015 <html lang="en">
1016   <head>
1017     <meta property="og:title" content="__OG_TITLE__">
1018     <meta property="og:description" content="__OG_DESCRIPTION__">
1019 ```
1020
1021 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!
1022
1023 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.
1024
1025 ## Pre-Rendering into Static HTML Files
1026
1027 If you’re hosting your `build` with a static hosting provider you can use [react-snapshot](https://www.npmjs.com/package/react-snapshot) to generate HTML pages for each route, or relative link, in your application. These pages will then seamlessly become active, or “hydrated”, when the JavaScript bundle has loaded.
1028
1029 There are also opportunities to use this outside of static hosting, to take the pressure off the server when generating and caching routes.
1030
1031 The primary benefit of pre-rendering is that you get the core content of each page _with_ the HTML payload—regardless of whether or not your JavaScript bundle successfully downloads. It also increases the likelihood that each route of your application will be picked up by search engines.
1032
1033 You can read more about [zero-configuration pre-rendering (also called snapshotting) here](https://medium.com/superhighfives/an-almost-static-stack-6df0a2791319).
1034
1035 ## Injecting Data from the Server into the Page
1036
1037 Similarly to the previous section, you can leave some placeholders in the HTML that inject global variables, for example:
1038
1039 ```js
1040 <!doctype html>
1041 <html lang="en">
1042   <head>
1043     <script>
1044       window.SERVER_DATA = __SERVER_DATA__;
1045     </script>
1046 ```
1047
1048 Then, on the server, you can replace `__SERVER_DATA__` with a JSON of real data right before sending the response. The client code can then read `window.SERVER_DATA` to use it. **Make sure to [sanitize the JSON before sending it to the client](https://medium.com/node-security/the-most-common-xss-vulnerability-in-react-js-applications-2bdffbcc1fa0) as it makes your app vulnerable to XSS attacks.**
1049
1050 ## Running Tests
1051
1052 >Note: this feature is available with `react-scripts@0.3.0` and higher.<br>
1053 >[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)
1054
1055 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.
1056
1057 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.
1058
1059 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.
1060
1061 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.
1062
1063 ### Filename Conventions
1064
1065 Jest will look for test files with any of the following popular naming conventions:
1066
1067 * Files with `.js` suffix in `__tests__` folders.
1068 * Files with `.test.js` suffix.
1069 * Files with `.spec.js` suffix.
1070
1071 The `.test.js` / `.spec.js` files (or the `__tests__` folders) can be located at any depth under the `src` top level folder.
1072
1073 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.
1074
1075 ### Command Line Interface
1076
1077 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.
1078
1079 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:
1080
1081 ![Jest watch mode](http://facebook.github.io/jest/img/blog/15-watch.gif)
1082
1083 ### Version Control Integration
1084
1085 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.
1086
1087 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.
1088
1089 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.
1090
1091 ### Writing Tests
1092
1093 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.
1094
1095 Jest provides a built-in `expect()` global function for making assertions. A basic test could look like this:
1096
1097 ```js
1098 import sum from './sum';
1099
1100 it('sums numbers', () => {
1101   expect(sum(1, 2)).toEqual(3);
1102   expect(sum(2, 2)).toEqual(4);
1103 });
1104 ```
1105
1106 All `expect()` matchers supported by Jest are [extensively documented here](http://facebook.github.io/jest/docs/expect.html).<br>
1107 You can also use [`jest.fn()` and `expect(fn).toBeCalled()`](http://facebook.github.io/jest/docs/expect.html#tohavebeencalled) to create “spies” or mock functions.
1108
1109 ### Testing Components
1110
1111 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.
1112
1113 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:
1114
1115 ```js
1116 import React from 'react';
1117 import ReactDOM from 'react-dom';
1118 import App from './App';
1119
1120 it('renders without crashing', () => {
1121   const div = document.createElement('div');
1122   ReactDOM.render(<App />, div);
1123 });
1124 ```
1125
1126 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`.
1127
1128 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.
1129
1130 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:
1131
1132 ```sh
1133 npm install --save-dev enzyme react-test-renderer
1134 ```
1135
1136 ```js
1137 import React from 'react';
1138 import { shallow } from 'enzyme';
1139 import App from './App';
1140
1141 it('renders without crashing', () => {
1142   shallow(<App />);
1143 });
1144 ```
1145
1146 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.
1147
1148 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.
1149
1150 Here is an example from Enzyme documentation that asserts specific output, rewritten to use Jest matchers:
1151
1152 ```js
1153 import React from 'react';
1154 import { shallow } from 'enzyme';
1155 import App from './App';
1156
1157 it('renders welcome message', () => {
1158   const wrapper = shallow(<App />);
1159   const welcome = <h2>Welcome to React</h2>;
1160   // expect(wrapper.contains(welcome)).to.equal(true);
1161   expect(wrapper.contains(welcome)).toEqual(true);
1162 });
1163 ```
1164
1165 All Jest matchers are [extensively documented here](http://facebook.github.io/jest/docs/expect.html).<br>
1166 Nevertheless you can use a third-party assertion library like [Chai](http://chaijs.com/) if you want to, as described below.
1167
1168 Additionally, you might find [jest-enzyme](https://github.com/blainekasten/enzyme-matchers) helpful to simplify your tests with readable matchers. The above `contains` code can be written simpler with jest-enzyme.
1169
1170 ```js
1171 expect(wrapper).toContainReact(welcome)
1172 ```
1173
1174 To setup jest-enzyme with Create React App, follow the instructions for [initializing your test environment](#initializing-test-environment) to import `jest-enzyme`. **Note that currently only version 2.x is compatible with Create React App.**
1175
1176 ```sh
1177 npm install --save-dev jest-enzyme@2.x
1178 ```
1179
1180 ```js
1181 // src/setupTests.js
1182 import 'jest-enzyme';
1183 ```
1184
1185
1186 ### Using Third Party Assertion Libraries
1187
1188 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).
1189
1190 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:
1191
1192 ```js
1193 import sinon from 'sinon';
1194 import { expect } from 'chai';
1195 ```
1196
1197 and then use them in your tests like you normally do.
1198
1199 ### Initializing Test Environment
1200
1201 >Note: this feature is available with `react-scripts@0.4.0` and higher.
1202
1203 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.
1204
1205 For example:
1206
1207 #### `src/setupTests.js`
1208 ```js
1209 const localStorageMock = {
1210   getItem: jest.fn(),
1211   setItem: jest.fn(),
1212   clear: jest.fn()
1213 };
1214 global.localStorage = localStorageMock
1215 ```
1216
1217 ### Focusing and Excluding Tests
1218
1219 You can replace `it()` with `xit()` to temporarily exclude a test from being executed.<br>
1220 Similarly, `fit()` lets you focus on a specific test without running any other tests.
1221
1222 ### Coverage Reporting
1223
1224 Jest has an integrated coverage reporter that works well with ES6 and requires no configuration.<br>
1225 Run `npm test -- --coverage` (note extra `--` in the middle) to include a coverage report like this:
1226
1227 ![coverage report](http://i.imgur.com/5bFhnTS.png)
1228
1229 Note that tests run much slower with coverage so it is recommended to run it separately from your normal workflow.
1230
1231 ### Continuous Integration
1232
1233 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`.
1234
1235 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.
1236
1237 Popular CI servers already set the environment variable `CI` by default but you can do this yourself too:
1238
1239 ### On CI servers
1240 #### Travis CI
1241
1242 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.
1243 1. Add a `.travis.yml` file to your git repository.
1244 ```
1245 language: node_js
1246 node_js:
1247   - 4
1248   - 6
1249 cache:
1250   directories:
1251     - node_modules
1252 script:
1253   - npm test
1254   - npm run build
1255 ```
1256 1. Trigger your first build with a git push.
1257 1. [Customize your Travis CI Build](https://docs.travis-ci.com/user/customizing-the-build/) if needed.
1258
1259 ### On your own environment
1260 ##### Windows (cmd.exe)
1261
1262 ```cmd
1263 set CI=true&&npm test
1264 ```
1265
1266 ```cmd
1267 set CI=true&&npm run build
1268 ```
1269
1270 (Note: the lack of whitespace is intentional.)
1271
1272 ##### Linux, macOS (Bash)
1273
1274 ```bash
1275 CI=true npm test
1276 ```
1277
1278 ```bash
1279 CI=true npm run build
1280 ```
1281
1282 The test command will force Jest to run tests once instead of launching the watcher.
1283
1284 >  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.
1285
1286 The build command will check for linter warnings and fail if any are found.
1287
1288 ### Disabling jsdom
1289
1290 By default, the `package.json` of the generated project looks like this:
1291
1292 ```js
1293   // ...
1294   "scripts": {
1295     // ...
1296     "test": "react-scripts test --env=jsdom"
1297   }
1298 ```
1299
1300 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>
1301 To help you make up your mind, here is a list of APIs that **need jsdom**:
1302
1303 * Any browser globals like `window` and `document`
1304 * [`ReactDOM.render()`](https://facebook.github.io/react/docs/top-level-api.html#reactdom.render)
1305 * [`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)
1306 * [`mount()`](http://airbnb.io/enzyme/docs/api/mount.html) in [Enzyme](http://airbnb.io/enzyme/index.html)
1307
1308 In contrast, **jsdom is not needed** for the following APIs:
1309
1310 * [`TestUtils.createRenderer()`](https://facebook.github.io/react/docs/test-utils.html#shallow-rendering) (shallow rendering)
1311 * [`shallow()`](http://airbnb.io/enzyme/docs/api/shallow.html) in [Enzyme](http://airbnb.io/enzyme/index.html)
1312
1313 Finally, jsdom is also not needed for [snapshot testing](http://facebook.github.io/jest/blog/2016/07/27/jest-14.html).
1314
1315 ### Snapshot Testing
1316
1317 Snapshot testing is a 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. [Read more about snapshot testing.](http://facebook.github.io/jest/blog/2016/07/27/jest-14.html)
1318
1319 ### Editor Integration
1320
1321 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.
1322
1323 ![VS Code Jest Preview](https://cloud.githubusercontent.com/assets/49038/20795349/a032308a-b7c8-11e6-9b34-7eeac781003f.png)
1324
1325 <!--
1326 ## Developing Components in Isolation
1327
1328 Usually, in an app, you have a lot of UI components, and each of them has many different states.
1329 For an example, a simple button component could have following states:
1330
1331 * With a text label.
1332 * With an emoji.
1333 * In the disabled mode.
1334
1335 Usually, it’s hard to see these states without running a sample app or some examples.
1336
1337 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**.
1338
1339 ![React Storybook Demo](http://i.imgur.com/7CIAWpB.gif)
1340
1341 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.
1342
1343 **Here’s how to setup your app with Storybook:**
1344
1345 First, install the following npm package globally:
1346
1347 ```sh
1348 npm install -g getstorybook
1349 ```
1350
1351 Then, run the following command inside your app’s directory:
1352
1353 ```sh
1354 getstorybook
1355 ```
1356
1357 After that, follow the instructions on the screen.
1358
1359 Learn more about React Storybook:
1360
1361 * Screencast: [Getting Started with React Storybook](https://egghead.io/lessons/react-getting-started-with-react-storybook)
1362 * [GitHub Repo](https://github.com/kadirahq/react-storybook)
1363 * [Documentation](https://storybooks.js.org/docs/react-storybook/basics/introduction/)
1364 * [Snapshot Testing](https://github.com/kadirahq/storyshots) with React Storybook
1365 -->
1366
1367 ## Making a Progressive Web App
1368
1369 By default, the production build is a fully functional, offline-first
1370 [Progressive Web App](https://developers.google.com/web/progressive-web-apps/).
1371
1372 Progressive Web Apps are faster and more reliable than traditional web pages, and provide an engaging mobile experience:
1373
1374  * All static site assets are cached so that your page loads fast on subsequent visits, regardless of network connectivity (such as 2G or 3G). Updates are downloaded in the background.
1375  * Your app will work regardless of network state, even if offline. This means your users will be able to use your app at 10,000 feet and on the Subway.
1376  * On mobile devices, your app can be added directly to the user's home screen, app icon and all. You can also re-engage users using web **push notifications**. This eliminates the need for the app store.
1377
1378 The [`sw-precache-webpack-plugin`](https://github.com/goldhand/sw-precache-webpack-plugin)
1379 is integrated into production configuration,
1380 and it will take care of generating a service worker file that will automatically
1381 precache all of your local assets and keep them up to date as you deploy updates.
1382 The service worker will use a [cache-first strategy](https://developers.google.com/web/fundamentals/instant-and-offline/offline-cookbook/#cache-falling-back-to-network)
1383 for handling all requests for local assets, including the initial HTML, ensuring
1384 that you web app is reliably fast, even on a slow or unreliable network.
1385
1386 If you would prefer not to enable service workers prior to your initial
1387 production deployment, then remove the call to `serviceWorkerRegistration.register()`
1388 from [`src/index.js`](src/index.js).
1389
1390 If you had previously enabled service workers in your production deployment and
1391 have decided that you would like to disable them for all your existing users,
1392 you can swap out the call to `serviceWorkerRegistration.register()` in
1393 [`src/index.js`](src/index.js) with a call to `serviceWorkerRegistration.unregister()`.
1394 After the user visits a page that has `serviceWorkerRegistration.unregister()`,
1395 the service worker will be uninstalled.
1396
1397 ### Offline-First Considerations
1398
1399 1. Service workers [require HTTPS](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers#you_need_https),
1400 although to facilitate local testing, that policy
1401 [does not apply to `localhost`](http://stackoverflow.com/questions/34160509/options-for-testing-service-workers-via-http/34161385#34161385).
1402 If your production web server does not support HTTPS, then the service worker
1403 registration will fail, but the rest of your web app will remain functional.
1404
1405 1. Service workers are [not currently supported](https://jakearchibald.github.io/isserviceworkerready/)
1406 in all web browsers. Service worker registration [won't be attempted](src/registerServiceWorker.js)
1407 on browsers that lack support.
1408
1409 1. The service worker is only enabled in the [production environment](#deployment),
1410 e.g. the output of `npm run build`. It's recommended that you do not enable an
1411 offline-first service worker in a development environment, as it can lead to
1412 frustration when previously cached assets are used and do not include the latest
1413 changes you've made locally.
1414
1415 1. If you *need* to test your offline-first service worker locally, build
1416 the application (using `npm run build`) and run a simple http server from your
1417 build directory. After running the build script, `create-react-app` will give
1418 instructions for one way to test your production build locally and the [deployment instructions](#deployment) have
1419 instructions for using other methods. *Be sure to always use an
1420 incognito window to avoid complications with your browser cache.*
1421
1422 1. If possible, configure your production environment to serve the generated
1423 `service-worker.js` [with HTTP caching disabled](http://stackoverflow.com/questions/38843970/service-worker-javascript-update-frequency-every-24-hours).
1424 If that's not possible—[GitHub Pages](#github-pages), for instance, does not
1425 allow you to change the default 10 minute HTTP cache lifetime—then be aware
1426 that if you visit your production site, and then revisit again before
1427 `service-worker.js` has expired from your HTTP cache, you'll continue to get
1428 the previously cached assets from the service worker. If you have an immediate
1429 need to view your updated production deployment, performing a shift-refresh
1430 will temporarily disable the service worker and retrieve all assets from the
1431 network.
1432
1433 1. Users aren't always familiar with offline-first web apps. It can be useful to
1434 [let the user know](https://developers.google.com/web/fundamentals/instant-and-offline/offline-ux#inform_the_user_when_the_app_is_ready_for_offline_consumption)
1435 when the service worker has finished populating your caches (showing a "This web
1436 app works offline!" message) and also let them know when the service worker has
1437 fetched the latest updates that will be available the next time they load the
1438 page (showing a "New content is available; please refresh." message). Showing
1439 this messages is currently left as an exercise to the developer, but as a
1440 starting point, you can make use of the logic included in [`src/registerServiceWorker.js`](src/registerServiceWorker.js), which
1441 demonstrates which service worker lifecycle events to listen for to detect each
1442 scenario, and which as a default, just logs appropriate messages to the
1443 JavaScript console.
1444
1445 1. By default, the generated service worker file will not intercept or cache any
1446 cross-origin traffic, like HTTP [API requests](#integrating-with-an-api-backend),
1447 images, or embeds loaded from a different domain. If you would like to use a
1448 runtime caching strategy for those requests, you can [`eject`](#npm-run-eject)
1449 and then configure the
1450 [`runtimeCaching`](https://github.com/GoogleChrome/sw-precache#runtimecaching-arrayobject)
1451 option in the `SWPrecacheWebpackPlugin` section of
1452 [`webpack.config.prod.js`](../config/webpack.config.prod.js).
1453
1454 ### Progressive Web App Metadata
1455
1456 The default configuration includes a web app manifest located at
1457 [`public/manifest.json`](public/manifest.json), that you can customize with
1458 details specific to your web application.
1459
1460 When a user adds a web app to their homescreen using Chrome or Firefox on
1461 Android, the metadata in [`manifest.json`](public/manifest.json) determines what
1462 icons, names, and branding colors to use when the web app is displayed.
1463 [The Web App Manifest guide](https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/)
1464 provides more context about what each field means, and how your customizations
1465 will affect your users' experience.
1466
1467 ## Deployment
1468
1469 `npm run build` creates a `build` directory with a production build of your app. Set up your favourite HTTP server so that a visitor to your site is served `index.html`, and requests to static paths like `/static/js/main.<hash>.js` are served with the contents of the `/static/js/main.<hash>.js` file.
1470
1471 ### Static Server
1472
1473 For environments using [Node](https://nodejs.org/), the easiest way to handle this would be to install [serve](https://github.com/zeit/serve) and let it handle the rest:
1474
1475 ```sh
1476 npm install -g serve
1477 serve -s build
1478 ```
1479
1480 The last command shown above will serve your static site on the port **5000**. Like many of [serve](https://github.com/zeit/serve)’s internal settings, the port can be adjusted using the `-p` or `--port` flags.
1481
1482 Run this command to get a full list of the options available:
1483
1484 ```sh
1485 serve -h
1486 ```
1487
1488 ### Other Solutions
1489
1490 You don’t necessarily need a static server in order to run a Create React App project in production. It works just as fine integrated into an existing dynamic one.
1491
1492 Here’s a programmatic example using [Node](https://nodejs.org/) and [Express](http://expressjs.com/):
1493
1494 ```javascript
1495 const express = require('express');
1496 const path = require('path');
1497 const app = express();
1498
1499 app.use(express.static(path.join(__dirname, 'build')));
1500
1501 app.get('/', function (req, res) {
1502   res.sendFile(path.join(__dirname, 'build', 'index.html'));
1503 });
1504
1505 app.listen(9000);
1506 ```
1507
1508 The choice of your server software isn’t important either. Since Create React App is completely platform-agnostic, there’s no need to explicitly use Node.
1509
1510 The `build` folder with static assets is the only output produced by Create React App.
1511
1512 However this is not quite enough if you use client-side routing. Read the next section if you want to support URLs like `/todos/42` in your single-page app.
1513
1514 ### Serving Apps with Client-Side Routing
1515
1516 If you use routers that use the HTML5 [`pushState` history API](https://developer.mozilla.org/en-US/docs/Web/API/History_API#Adding_and_modifying_history_entries) under the hood (for example, [React Router](https://github.com/ReactTraining/react-router) with `browserHistory`), many static file servers will fail. For example, if you used React Router with a route for `/todos/42`, the development server will respond to `localhost:3000/todos/42` properly, but an Express serving a production build as above will not.
1517
1518 This is because when there is a fresh page load for a `/todos/42`, the server looks for the file `build/todos/42` and does not find it. The server needs to be configured to respond to a request to `/todos/42` by serving `index.html`. For example, we can amend our Express example above to serve `index.html` for any unknown paths:
1519
1520 ```diff
1521  app.use(express.static(path.join(__dirname, 'build')));
1522
1523 -app.get('/', function (req, res) {
1524 +app.get('/*', function (req, res) {
1525    res.sendFile(path.join(__dirname, 'build', 'index.html'));
1526  });
1527 ```
1528
1529 If you’re using [Apache](https://httpd.apache.org/), you need to create a `.htaccess` file in the `public` folder that looks like this:
1530
1531 ```
1532     Options -MultiViews
1533     RewriteEngine On
1534     RewriteCond %{REQUEST_FILENAME} !-f
1535     RewriteRule ^ index.html [QSA,L]
1536 ```
1537
1538 It will get copied to the `build` folder when you run `npm run build`.
1539
1540 Now requests to `/todos/42` will be handled correctly both in development and in production.
1541
1542 On a production build, and in a browser that supports [service workers](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers),
1543 the service worker will automatically handle all navigation requests, like for
1544 `/todos/42`, by serving the cached copy of your `index.html`. This
1545 service worker navigation routing can be configured or disabled by
1546 [`eject`ing](#npm-run-eject) and then modifying the
1547 [`navigateFallback`](https://github.com/GoogleChrome/sw-precache#navigatefallback-string)
1548 and [`navigateFallbackWhitelist`](https://github.com/GoogleChrome/sw-precache#navigatefallbackwhitelist-arrayregexp)
1549 options of the `SWPreachePlugin` [configuration](../config/webpack.config.prod.js).
1550
1551 ### Building for Relative Paths
1552
1553 By default, Create React App produces a build assuming your app is hosted at the server root.<br>
1554 To override this, specify the `homepage` in your `package.json`, for example:
1555
1556 ```js
1557   "homepage": "http://mywebsite.com/relativepath",
1558 ```
1559
1560 This will let Create React App correctly infer the root path to use in the generated HTML file.
1561
1562 #### Serving the Same Build from Different Paths
1563
1564 >Note: this feature is available with `react-scripts@0.9.0` and higher.
1565
1566 If you are not using the HTML5 `pushState` history API or not using client-side routing at all, it is unnecessary to specify the URL from which your app will be served. Instead, you can put this in your `package.json`:
1567
1568 ```js
1569   "homepage": ".",
1570 ```
1571
1572 This will make sure that all the asset paths are relative to `index.html`. You will then be able to move your app from `http://mywebsite.com` to `http://mywebsite.com/relativepath` or even `http://mywebsite.com/relative/path` without having to rebuild it.
1573
1574 ### Azure
1575
1576 See [this](https://medium.com/@to_pe/deploying-create-react-app-on-microsoft-azure-c0f6686a4321) blog post on how to deploy your React app to [Microsoft Azure](https://azure.microsoft.com/).
1577
1578 ### Firebase
1579
1580 Install the Firebase CLI if you haven’t already by running `npm install -g firebase-tools`. Sign up for a [Firebase account](https://console.firebase.google.com/) and create a new project. Run `firebase login` and login with your previous created Firebase account.
1581
1582 Then run the `firebase init` command from your project’s root. You need to choose the **Hosting: Configure and deploy Firebase Hosting sites** and choose the Firebase project you created in the previous step. You will need to agree with `database.rules.json` being created, choose `build` as the public directory, and also agree to **Configure as a single-page app** by replying with `y`.
1583
1584 ```sh
1585     === Project Setup
1586
1587     First, let's associate this project directory with a Firebase project.
1588     You can create multiple project aliases by running firebase use --add,
1589     but for now we'll just set up a default project.
1590
1591     ? What Firebase project do you want to associate as default? Example app (example-app-fd690)
1592
1593     === Database Setup
1594
1595     Firebase Realtime Database Rules allow you to define how your data should be
1596     structured and when your data can be read from and written to.
1597
1598     ? What file should be used for Database Rules? database.rules.json
1599     ✔  Database Rules for example-app-fd690 have been downloaded to database.rules.json.
1600     Future modifications to database.rules.json will update Database Rules when you run
1601     firebase deploy.
1602
1603     === Hosting Setup
1604
1605     Your public directory is the folder (relative to your project directory) that
1606     will contain Hosting assets to uploaded with firebase deploy. If you
1607     have a build process for your assets, use your build's output directory.
1608
1609     ? What do you want to use as your public directory? build
1610     ? Configure as a single-page app (rewrite all urls to /index.html)? Yes
1611     ✔  Wrote build/index.html
1612
1613     i  Writing configuration info to firebase.json...
1614     i  Writing project information to .firebaserc...
1615
1616     ✔  Firebase initialization complete!
1617 ```
1618
1619 Now, after you create a production build with `npm run build`, you can deploy it by running `firebase deploy`.
1620
1621 ```sh
1622     === Deploying to 'example-app-fd690'...
1623
1624     i  deploying database, hosting
1625     ✔  database: rules ready to deploy.
1626     i  hosting: preparing build directory for upload...
1627     Uploading: [==============================          ] 75%✔  hosting: build folder uploaded successfully
1628     ✔  hosting: 8 files uploaded successfully
1629     i  starting release process (may take several minutes)...
1630
1631     ✔  Deploy complete!
1632
1633     Project Console: https://console.firebase.google.com/project/example-app-fd690/overview
1634     Hosting URL: https://example-app-fd690.firebaseapp.com
1635 ```
1636
1637 For more information see [Add Firebase to your JavaScript Project](https://firebase.google.com/docs/web/setup).
1638
1639 ### GitHub Pages
1640
1641 >Note: this feature is available with `react-scripts@0.2.0` and higher.
1642
1643 #### Step 1: Add `homepage` to `package.json`
1644
1645 **The step below is important!**<br>
1646 **If you skip it, your app will not deploy correctly.**
1647
1648 Open your `package.json` and add a `homepage` field:
1649
1650 ```js
1651   "homepage": "https://myusername.github.io/my-app",
1652 ```
1653
1654 Create React App uses the `homepage` field to determine the root URL in the built HTML file.
1655
1656 #### Step 2: Install `gh-pages` and add `deploy` to `scripts` in `package.json`
1657
1658 Now, whenever you run `npm run build`, you will see a cheat sheet with instructions on how to deploy to GitHub Pages.
1659
1660 To publish it at [https://myusername.github.io/my-app](https://myusername.github.io/my-app), run:
1661
1662 ```sh
1663 npm install --save-dev gh-pages
1664 ```
1665
1666 Add the following scripts in your `package.json`:
1667
1668 ```js
1669   // ...
1670   "scripts": {
1671     // ...
1672     "predeploy": "npm run build",
1673     "deploy": "gh-pages -d build"
1674   }
1675 ```
1676
1677 The `predeploy` script will run automatically before `deploy` is run.
1678
1679 #### Step 3: Deploy the site by running `npm run deploy`
1680
1681 Then run:
1682
1683 ```sh
1684 npm run deploy
1685 ```
1686
1687 #### Step 4: Ensure your project’s settings use `gh-pages`
1688
1689 Finally, make sure **GitHub Pages** option in your GitHub project settings is set to use the `gh-pages` branch:
1690
1691 <img src="http://i.imgur.com/HUjEr9l.png" width="500" alt="gh-pages branch setting">
1692
1693 #### Step 5: Optionally, configure the domain
1694
1695 You can configure a custom domain with GitHub Pages by adding a `CNAME` file to the `public/` folder.
1696
1697 #### Notes on client-side routing
1698
1699 GitHub Pages doesn’t support routers that use the HTML5 `pushState` history API under the hood (for example, React Router using `browserHistory`). This is because when there is a fresh page load for a url like `http://user.github.io/todomvc/todos/42`, where `/todos/42` is a frontend route, the GitHub Pages server returns 404 because it knows nothing of `/todos/42`. If you want to add a router to a project hosted on GitHub Pages, here are a couple of solutions:
1700
1701 * You could switch from using HTML5 history API to routing with hashes. If you use React Router, you can switch to `hashHistory` for this effect, but the URL will be longer and more verbose (for example, `http://user.github.io/todomvc/#/todos/42?_k=yknaj`). [Read more](https://github.com/reactjs/react-router/blob/master/docs/guides/Histories.md#histories) about different history implementations in React Router.
1702 * Alternatively, you can use a trick to teach GitHub Pages to handle 404 by redirecting to your `index.html` page with a special redirect parameter. You would need to add a `404.html` file with the redirection code to the `build` folder before deploying your project, and you’ll need to add code handling the redirect parameter to `index.html`. You can find a detailed explanation of this technique [in this guide](https://github.com/rafrex/spa-github-pages).
1703
1704 ### Heroku
1705
1706 Use the [Heroku Buildpack for Create React App](https://github.com/mars/create-react-app-buildpack).<br>
1707 You can find instructions in [Deploying React with Zero Configuration](https://blog.heroku.com/deploying-react-with-zero-configuration).
1708
1709 #### Resolving Heroku Deployment Errors
1710
1711 Sometimes `npm run build` works locally but fails during deploy via Heroku. Following are the most common cases.
1712
1713 ##### "Module not found: Error: Cannot resolve 'file' or 'directory'"
1714
1715 If you get something like this:
1716
1717 ```
1718 remote: Failed to create a production build. Reason:
1719 remote: Module not found: Error: Cannot resolve 'file' or 'directory'
1720 MyDirectory in /tmp/build_1234/src
1721 ```
1722
1723 It means you need to ensure that the lettercase of the file or directory you `import` matches the one you see on your filesystem or on GitHub.
1724
1725 This is important because Linux (the operating system used by Heroku) is case sensitive. So `MyDirectory` and `mydirectory` are two distinct directories and thus, even though the project builds locally, the difference in case breaks the `import` statements on Heroku remotes.
1726
1727 ##### "Could not find a required file."
1728
1729 If you exclude or ignore necessary files from the package you will see a error similar this one:
1730
1731 ```
1732 remote: Could not find a required file.
1733 remote:   Name: `index.html`
1734 remote:   Searched in: /tmp/build_a2875fc163b209225122d68916f1d4df/public
1735 remote:
1736 remote: npm ERR! Linux 3.13.0-105-generic
1737 remote: npm ERR! argv "/tmp/build_a2875fc163b209225122d68916f1d4df/.heroku/node/bin/node" "/tmp/build_a2875fc163b209225122d68916f1d4df/.heroku/node/bin/npm" "run" "build"
1738 ```
1739
1740 In this case, ensure that the file is there with the proper lettercase and that’s not ignored on your local `.gitignore` or `~/.gitignore_global`.
1741
1742 ### Modulus
1743
1744 See the [Modulus blog post](http://blog.modulus.io/deploying-react-apps-on-modulus) on how to deploy your react app to Modulus.
1745
1746 ### Netlify
1747
1748 **To do a manual deploy to Netlify’s CDN:**
1749
1750 ```sh
1751 npm install netlify-cli
1752 netlify deploy
1753 ```
1754
1755 Choose `build` as the path to deploy.
1756
1757 **To setup continuous delivery:**
1758
1759 With this setup Netlify will build and deploy when you push to git or open a pull request:
1760
1761 1. [Start a new netlify project](https://app.netlify.com/signup)
1762 2. Pick your Git hosting service and select your repository
1763 3. Click `Build your site`
1764
1765 **Support for client-side routing:**
1766
1767 To support `pushState`, make sure to create a `public/_redirects` file with the following rewrite rules:
1768
1769 ```
1770 /*  /index.html  200
1771 ```
1772
1773 When you build the project, Create React App will place the `public` folder contents into the build output.
1774
1775 ### Now
1776
1777 [now](https://zeit.co/now) offers a zero-configuration single-command deployment. You can use `now` to deploy your app for free.
1778
1779 1. Install the `now` command-line tool either via the recommended [desktop tool](https://zeit.co/download) or via node with `npm install -g now`.
1780
1781 2. Build your app by running `npm run build`.
1782
1783 3. Move into the build directory by running `cd build`.
1784
1785 4. Run `now --name your-project-name` from within the build directory. You will see a **now.sh** URL in your output like this:
1786
1787     ```
1788     > Ready! https://your-project-name-tpspyhtdtk.now.sh (copied to clipboard)
1789     ```
1790
1791     Paste that URL into your browser when the build is complete, and you will see your deployed app.
1792
1793 Details are available in [this article.](https://zeit.co/blog/unlimited-static)
1794
1795 ### S3 and CloudFront
1796
1797 See this [blog post](https://medium.com/@omgwtfmarc/deploying-create-react-app-to-s3-or-cloudfront-48dae4ce0af) on how to deploy your React app to Amazon Web Services [S3](https://aws.amazon.com/s3) and [CloudFront](https://aws.amazon.com/cloudfront/).
1798
1799 ### Surge
1800
1801 Install the Surge CLI if you haven’t already by running `npm install -g surge`. Run the `surge` command and log in you or create a new account.
1802
1803 When asked about the project path, make sure to specify the `build` folder, for example:
1804
1805 ```sh
1806        project path: /path/to/project/build
1807 ```
1808
1809 Note that in order to support routers that use HTML5 `pushState` API, you may want to rename the `index.html` in your build folder to `200.html` before deploying to Surge. This [ensures that every URL falls back to that file](https://surge.sh/help/adding-a-200-page-for-client-side-routing).
1810
1811 ## Advanced Configuration
1812
1813 You can adjust various development and production settings by setting environment variables in your shell or with [.env](#adding-development-environment-variables-in-env).
1814
1815 Variable | Development | Production | Usage
1816 :--- | :---: | :---: | :---
1817 BROWSER | :white_check_mark: | :x: | By default, Create React App will open the default system browser, favoring Chrome on macOS. Specify a [browser](https://github.com/sindresorhus/opn#app) to override this behavior, or set it to `none` to disable it completely. If you need to customize the way the browser is launched, you can specify a node script instead. Any arguments passed to `npm start` will also be passed to this script, and the url where your app is served will be the last argument. Your script's file name must have the `.js` extension.
1818 HOST | :white_check_mark: | :x: | By default, the development web server binds to `localhost`. You may use this variable to specify a different host.
1819 PORT | :white_check_mark: | :x: | By default, the development web server will attempt to listen on port 3000 or prompt you to attempt the next available port. You may use this variable to specify a different port.
1820 HTTPS | :white_check_mark: | :x: | When set to `true`, Create React App will run the development server in `https` mode.
1821 PUBLIC_URL | :x: | :white_check_mark: | Create React App assumes your application is hosted at the serving web server's root or a subpath as specified in [`package.json` (`homepage`)](#building-for-relative-paths). Normally, Create React App ignores the hostname. You may use this variable to force assets to be referenced verbatim to the url you provide (hostname included). This may be particularly useful when using a CDN to host your application.
1822 CI | :large_orange_diamond: | :white_check_mark: | When set to `true`, Create React App treats warnings as failures in the build. It also makes the test runner non-watching. Most CIs set this flag by default.
1823
1824 ## Troubleshooting
1825
1826 ### `npm start` doesn’t detect changes
1827
1828 When you save a file while `npm start` is running, the browser should refresh with the updated code.<br>
1829 If this doesn’t happen, try one of the following workarounds:
1830
1831 * If your project is in a Dropbox folder, try moving it out.
1832 * If the watcher doesn’t see a file called `index.js` and you’re referencing it by the folder name, you [need to restart the watcher](https://github.com/facebookincubator/create-react-app/issues/1164) due to a Webpack bug.
1833 * Some editors like Vim and IntelliJ have a “safe write” feature that currently breaks the watcher. You will need to disable it. Follow the instructions in [“Adjusting Your Text Editor”](https://webpack.js.org/guides/development/#adjusting-your-text-editor).
1834 * If your project path contains parentheses, try moving the project to a path without them. This is caused by a [Webpack watcher bug](https://github.com/webpack/watchpack/issues/42).
1835 * On Linux and macOS, you might need to [tweak system settings](https://webpack.github.io/docs/troubleshooting.html#not-enough-watchers) to allow more watchers.
1836 * If the project runs inside a virtual machine such as (a Vagrant provisioned) VirtualBox, create an `.env` file in your project directory if it doesn’t exist, and add `CHOKIDAR_USEPOLLING=true` to it. This ensures that the next time you run `npm start`, the watcher uses the polling mode, as necessary inside a VM.
1837
1838 If none of these solutions help please leave a comment [in this thread](https://github.com/facebookincubator/create-react-app/issues/659).
1839
1840 ### `npm test` hangs on macOS Sierra
1841
1842 If you run `npm test` and the console gets stuck after printing `react-scripts test --env=jsdom` to the console there might be a problem with your [Watchman](https://facebook.github.io/watchman/) installation as described in [facebookincubator/create-react-app#713](https://github.com/facebookincubator/create-react-app/issues/713).
1843
1844 We recommend deleting `node_modules` in your project and running `npm install` (or `yarn` if you use it) first. If it doesn't help, you can try one of the numerous workarounds mentioned in these issues:
1845
1846 * [facebook/jest#1767](https://github.com/facebook/jest/issues/1767)
1847 * [facebook/watchman#358](https://github.com/facebook/watchman/issues/358)
1848 * [ember-cli/ember-cli#6259](https://github.com/ember-cli/ember-cli/issues/6259)
1849
1850 It is reported that installing Watchman 4.7.0 or newer fixes the issue. If you use [Homebrew](http://brew.sh/), you can run these commands to update it:
1851
1852 ```
1853 watchman shutdown-server
1854 brew update
1855 brew reinstall watchman
1856 ```
1857
1858 You can find [other installation methods](https://facebook.github.io/watchman/docs/install.html#build-install) on the Watchman documentation page.
1859
1860 If this still doesn’t help, try running `launchctl unload -F ~/Library/LaunchAgents/com.github.facebook.watchman.plist`.
1861
1862 There are also reports that *uninstalling* Watchman fixes the issue. So if nothing else helps, remove it from your system and try again.
1863
1864 ### `npm run build` silently fails
1865
1866 It is reported that `npm run build` can fail on machines with no swap space, which is common in cloud environments. If [the symptoms are matching](https://github.com/facebookincubator/create-react-app/issues/1133#issuecomment-264612171), consider adding some swap space to the machine you’re building on, or build the project locally.
1867
1868 ### `npm run build` fails on Heroku
1869
1870 This may be a problem with case sensitive filenames.
1871 Please refer to [this section](#resolving-heroku-deployment-errors).
1872
1873 ### Moment.js locales are missing
1874
1875 If you use a [Moment.js](https://momentjs.com/), you might notice that only the English locale is available by default. This is because the locale files are large, and you probably only need a subset of [all the locales provided by Moment.js](https://momentjs.com/#multiple-locale-support).
1876
1877 To add a specific Moment.js locale to your bundle, you need to import it explicitly.<br>
1878 For example:
1879
1880 ```js
1881 import moment from 'moment';
1882 import 'moment/locale/fr';
1883 ```
1884
1885 If import multiple locales this way, you can later switch between them by calling `moment.locale()` with the locale name:
1886
1887 ```js
1888 import moment from 'moment';
1889 import 'moment/locale/fr';
1890 import 'moment/locale/es';
1891
1892 // ...
1893
1894 moment.locale('fr');
1895 ```
1896
1897 This will only work for locales that have been explicitly imported before.
1898
1899 ## Something Missing?
1900
1901 If you have ideas for more “How To” recipes that should be on this page, [let us know](https://github.com/facebookincubator/create-react-app/issues) or [contribute some!](https://github.com/facebookincubator/create-react-app/edit/master/packages/react-scripts/template/README.md)