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

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

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

Dan Abramov's avatar
Dan Abramov committed
8
- [Updating to New Releases](#updating-to-new-releases)
Manav Sehgal's avatar
Manav Sehgal committed
9
10
11
- [Sending Feedback](#sending-feedback)
- [Folder Structure](#folder-structure)
- [Available Scripts](#available-scripts)
12
  - [npm start](#npm-start)
Dan Abramov's avatar
Dan Abramov committed
13
  - [npm test](#npm-test)
14
15
  - [npm run build](#npm-run-build)
  - [npm run eject](#npm-run-eject)
16
- [Supported Browsers](#supported-browsers)
17
- [Supported Language Features and Polyfills](#supported-language-features-and-polyfills)
18
- [Syntax Highlighting in the Editor](#syntax-highlighting-in-the-editor)
Dan Abramov's avatar
Dan Abramov committed
19
- [Displaying Lint Output in the Editor](#displaying-lint-output-in-the-editor)
20
- [Debugging in the Editor](#debugging-in-the-editor)
21
- [Formatting Code Automatically](#formatting-code-automatically)
22
- [Changing the Page `<title>`](#changing-the-page-title)
Dan Abramov's avatar
Dan Abramov committed
23
24
- [Installing a Dependency](#installing-a-dependency)
- [Importing a Component](#importing-a-component)
25
- [Code Splitting](#code-splitting)
Dan Abramov's avatar
Dan Abramov committed
26
27
- [Adding a Stylesheet](#adding-a-stylesheet)
- [Post-Processing CSS](#post-processing-css)
28
- [Adding a CSS Preprocessor (Sass, Less etc.)](#adding-a-css-preprocessor-sass-less-etc)
29
- [Adding Images, Fonts, and Files](#adding-images-fonts-and-files)
30
- [Adding GraphQL files](#adding-graphql-files)
Dan Abramov's avatar
Dan Abramov committed
31
- [Using the `public` Folder](#using-the-public-folder)
32
33
34
  - [Changing the HTML](#changing-the-html)
  - [Adding Assets Outside of the Module System](#adding-assets-outside-of-the-module-system)
  - [When to Use the `public` Folder](#when-to-use-the-public-folder)
35
- [Using Global Variables](#using-global-variables)
Dan Abramov's avatar
Dan Abramov committed
36
- [Adding Bootstrap](#adding-bootstrap)
37
  - [Using a Custom Theme](#using-a-custom-theme)
Dan Abramov's avatar
Dan Abramov committed
38
- [Adding Flow](#adding-flow)
39
- [Adding a Router](#adding-a-router)
Dan Abramov's avatar
Dan Abramov committed
40
- [Adding Custom Environment Variables](#adding-custom-environment-variables)
41
42
43
  - [Referencing Environment Variables in the HTML](#referencing-environment-variables-in-the-html)
  - [Adding Temporary Environment Variables In Your Shell](#adding-temporary-environment-variables-in-your-shell)
  - [Adding Development Environment Variables In `.env`](#adding-development-environment-variables-in-env)
Dan Abramov's avatar
Dan Abramov committed
44
- [Can I Use Decorators?](#can-i-use-decorators)
Dan Abramov's avatar
Dan Abramov committed
45
- [Fetching Data with AJAX Requests](#fetching-data-with-ajax-requests)
46
47
48
- [Integrating with an API Backend](#integrating-with-an-api-backend)
  - [Node](#node)
  - [Ruby on Rails](#ruby-on-rails)
Dan Abramov's avatar
Dan Abramov committed
49
- [Proxying API Requests in Development](#proxying-api-requests-in-development)
50
  - ["Invalid Host Header" Errors After Configuring Proxy](#invalid-host-header-errors-after-configuring-proxy)
Joe Haddad's avatar
Joe Haddad committed
51
  - [Configuring the Proxy Manually](#configuring-the-proxy-manually)
52
  - [Configuring a WebSocket Proxy](#configuring-a-websocket-proxy)
53
- [Using HTTPS in Development](#using-https-in-development)
Dan Abramov's avatar
Dan Abramov committed
54
- [Generating Dynamic `<meta>` Tags on the Server](#generating-dynamic-meta-tags-on-the-server)
55
- [Pre-Rendering into Static HTML Files](#pre-rendering-into-static-html-files)
56
- [Injecting Data from the Server into the Page](#injecting-data-from-the-server-into-the-page)
Dan Abramov's avatar
Dan Abramov committed
57
58
59
60
61
62
63
- [Running Tests](#running-tests)
  - [Filename Conventions](#filename-conventions)
  - [Command Line Interface](#command-line-interface)
  - [Version Control Integration](#version-control-integration)
  - [Writing Tests](#writing-tests)
  - [Testing Components](#testing-components)
  - [Using Third Party Assertion Libraries](#using-third-party-assertion-libraries)
64
  - [Initializing Test Environment](#initializing-test-environment)
65
  - [Focusing and Excluding Tests](#focusing-and-excluding-tests)
Dan Abramov's avatar
Dan Abramov committed
66
67
68
  - [Coverage Reporting](#coverage-reporting)
  - [Continuous Integration](#continuous-integration)
  - [Disabling jsdom](#disabling-jsdom)
69
  - [Snapshot Testing](#snapshot-testing)
Orta's avatar
Orta committed
70
  - [Editor Integration](#editor-integration)
71
- [Debugging Tests](#debugging-tests)
Dan Abramov's avatar
Dan Abramov committed
72
73
  - [Debugging Tests in Chrome](#debugging-tests-in-chrome)
  - [Debugging Tests in Visual Studio Code](#debugging-tests-in-visual-studio-code)
74
75
76
- [Developing Components in Isolation](#developing-components-in-isolation)
  - [Getting Started with Storybook](#getting-started-with-storybook)
  - [Getting Started with Styleguidist](#getting-started-with-styleguidist)
77
- [Sharing Components in a Monorepo](#sharing-components-in-a-monorepo)
Dan Abramov's avatar
Dan Abramov committed
78
- [Publishing Components to npm](#publishing-components-to-npm)
Dan Abramov's avatar
Dan Abramov committed
79
- [Making a Progressive Web App](#making-a-progressive-web-app)
80
  - [Opting Out of Caching](#opting-out-of-caching)
81
82
  - [Offline-First Considerations](#offline-first-considerations)
  - [Progressive Web App Metadata](#progressive-web-app-metadata)
83
- [Analyzing the Bundle Size](#analyzing-the-bundle-size)
84
- [Deployment](#deployment)
85
86
  - [Static Server](#static-server)
  - [Other Solutions](#other-solutions)
87
  - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing)
88
    - [Service Worker Considerations](#service-worker-considerations)
89
  - [Building for Relative Paths](#building-for-relative-paths)
90
  - [Customizing Environment Variables for Arbitrary Build Environments](#customizing-environment-variables-for-arbitrary-build-environments)
91
  - [Azure](#azure)
92
  - [Firebase](#firebase)
93
  - [GitHub Pages](#github-pages)
94
  - [Heroku](#heroku)
95
  - [Netlify](#netlify)
96
  - [Now](#now)
97
  - [S3 and CloudFront](#s3-and-cloudfront)
98
  - [Surge](#surge)
99
- [Advanced Configuration](#advanced-configuration)
100
- [Troubleshooting](#troubleshooting)
101
  - [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes)
102
  - [`npm test` hangs or crashes on macOS Sierra](#npm-test-hangs-or-crashes-on-macos-sierra)
103
  - [`npm run build` exits too early](#npm-run-build-exits-too-early)
104
  - [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku)
105
  - [`npm run build` fails to minify](#npm-run-build-fails-to-minify)
106
  - [Moment.js locales are missing](#momentjs-locales-are-missing)
107
- [Alternatives to Ejecting](#alternatives-to-ejecting)
Dan Abramov's avatar
Dan Abramov committed
108
- [Something Missing?](#something-missing)
Manav Sehgal's avatar
Manav Sehgal committed
109

Dan Abramov's avatar
Dan Abramov committed
110
111
112
113
114
115
116
## Updating to New Releases

Create React App is divided into two packages:

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

Vadim Peretokin's avatar
Vadim Peretokin committed
117
You almost never need to update `create-react-app` itself: it delegates all the setup to `react-scripts`.
Dan Abramov's avatar
Dan Abramov committed
118
119
120

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.

121
To update an existing project to a new version of `react-scripts`, [open the changelog](https://github.com/facebook/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.
Dan Abramov's avatar
Dan Abramov committed
122

123
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/facebook/create-react-app/blob/master/CHANGELOG.md) for potential breaking changes.
Dan Abramov's avatar
Dan Abramov committed
124
125
126

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

Dan Abramov's avatar
Dan Abramov committed
127
128
## Sending Feedback

129
We are always open to [your feedback](https://github.com/facebook/create-react-app/issues).
Dan Abramov's avatar
Dan Abramov committed
130

131
132
## Folder Structure

133
After creation, your project should look like this:
134
135
136
137
138
139

```
my-app/
  README.md
  node_modules/
  package.json
Dan Abramov's avatar
Dan Abramov committed
140
141
142
  public/
    index.html
    favicon.ico
143
144
145
  src/
    App.css
    App.js
146
    App.test.js
147
148
149
150
151
152
153
    index.css
    index.js
    logo.svg
```

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

Dan Abramov's avatar
Dan Abramov committed
154
* `public/index.html` is the page template;
155
156
157
158
* `src/index.js` is the JavaScript entry point.

You can delete or rename the other files.

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

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

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

Dan Abramov's avatar
Dan Abramov committed
168
169
## Available Scripts

170
In the project directory, you can run:
171
172
173
174
175
176
177
178
179

### `npm start`

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

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

Dan Abramov's avatar
Dan Abramov committed
180
181
### `npm test`

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

185
186
187
188
189
190
191
192
### `npm run build`

Builds the app for production to the `build` folder.<br>
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!

193
194
See the section about [deployment](#deployment) for more information.

195
196
197
198
199
200
### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

201
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.
202
203

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
Dan Abramov's avatar
Dan Abramov committed
204

205
206
207
208
209
210
## Supported Browsers

By default, the generated project uses the latest version of React.

You can refer [to the React documentation](https://reactjs.org/docs/react-dom.html#browser-support) for more information about supported browsers.

211
212
## Supported Language Features and Polyfills

213
This project supports a superset of the latest JavaScript standard.<br>
Dan Abramov's avatar
Dan Abramov committed
214
In addition to [ES6](https://github.com/lukehoban/es6features) syntax features, it also supports:
215

Dan Abramov's avatar
Dan Abramov committed
216
217
* [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016).
* [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017).
218
* [Object Rest/Spread Properties](https://github.com/tc39/proposal-object-rest-spread) (ES2018).
219
* [Dynamic import()](https://github.com/tc39/proposal-dynamic-import) (stage 3 proposal)
220
* [Class Fields and Static Properties](https://github.com/tc39/proposal-class-public-fields) (part of stage 3 proposal).
Dan Abramov's avatar
Dan Abramov committed
221
* [JSX](https://facebook.github.io/react/docs/introducing-jsx.html) and [Flow](https://flowtype.org/) syntax.
222
223
224

Learn more about [different proposal stages](https://babeljs.io/docs/plugins/#presets-stage-x-experimental-presets-).

225
While we recommend using 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.
226
227
228
229
230
231
232

Note that **the project only includes a few ES6 [polyfills](https://en.wikipedia.org/wiki/Polyfill)**:

* [`Object.assign()`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Object/assign) via [`object-assign`](https://github.com/sindresorhus/object-assign).
* [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) via [`promise`](https://github.com/then/promise).
* [`fetch()`](https://developer.mozilla.org/en/docs/Web/API/Fetch_API) via [`whatwg-fetch`](https://github.com/github/fetch).

233
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.
234

Dan Abramov's avatar
Dan Abramov committed
235
236
Also note that using some newer syntax features like `for...of` or `[...nonArrayValue]` causes Babel to emit code that depends on ES6 runtime features and might not work without a polyfill. When in doubt, use [Babel REPL](https://babeljs.io/repl/) to see what any specific syntax compiles down to.

237
238
## Syntax Highlighting in the Editor

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

Dan Abramov's avatar
Dan Abramov committed
241
## Displaying Lint Output in the Editor
Dan Abramov's avatar
Dan Abramov committed
242

Joe Haddad's avatar
Joe Haddad committed
243
>Note: this feature is available with `react-scripts@0.2.0` and higher.<br>
244
>It also only works with npm 3 or higher.
Dan Abramov's avatar
Dan Abramov committed
245
246
247
248
249

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

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

250
You would need to install an ESLint plugin for your editor first. Then, add a file called `.eslintrc` to the project root:
Dan Abramov's avatar
Dan Abramov committed
251
252
253

```js
{
254
  "extends": "react-app"
Dan Abramov's avatar
Dan Abramov committed
255
256
257
}
```

258
Now your editor should report the linting warnings.
Dan Abramov's avatar
Dan Abramov committed
259

Lufty Wiranda's avatar
Lufty Wiranda committed
260
261
262
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.

If you want to enforce a coding style for your project, consider using [Prettier](https://github.com/jlongster/prettier) instead of ESLint style rules.
Dan Abramov's avatar
Dan Abramov committed
263

264
265
## Debugging in the Editor

266
**This feature is currently only supported by [Visual Studio Code](https://code.visualstudio.com) and [WebStorm](https://www.jetbrains.com/webstorm/).**
267

268
269
270
Visual Studio Code and WebStorm support 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.

### Visual Studio Code
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290

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.

Then add the block below to your `launch.json` file and put it inside the `.vscode` folder in your app’s root directory.

```json
{
  "version": "0.2.0",
  "configurations": [{
    "name": "Chrome",
    "type": "chrome",
    "request": "launch",
    "url": "http://localhost:3000",
    "webRoot": "${workspaceRoot}/src",
    "sourceMapPathOverrides": {
      "webpack:///src/*": "${webRoot}/*"
    }
  }]
}
```
291
>Note: the URL may be different if you've made adjustments via the [HOST or PORT environment variables](#advanced-configuration).
292
293
294

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.

295
296
Having problems with VS Code Debugging? Please see their [troubleshooting guide](https://github.com/Microsoft/vscode-chrome-debug/blob/master/README.md#troubleshooting).

297
298
299
300
301
302
303
304
305
306
### WebStorm

You would need to have [WebStorm](https://www.jetbrains.com/webstorm/) and [JetBrains IDE Support](https://chrome.google.com/webstore/detail/jetbrains-ide-support/hmhgeddbohgjknpmjagkdomcpobmllji) Chrome extension installed.

In the WebStorm menu `Run` select `Edit Configurations...`. Then click `+` and select `JavaScript Debug`. Paste `http://localhost:3000` into the URL field and save the configuration.

>Note: the URL may be different if you've made adjustments via the [HOST or PORT environment variables](#advanced-configuration).

Start your app by running `npm start`, then press `^D` on macOS or `F9` on Windows and Linux or click the green debug icon to start debugging in WebStorm.

307
The same way you can debug your application in IntelliJ IDEA Ultimate, PhpStorm, PyCharm Pro, and RubyMine.
308

309
310
## Formatting Code Automatically

311
Prettier is an opinionated code formatter with support for JavaScript, CSS and JSON. With Prettier you can format the code you write automatically to ensure a code style within your project. See the [Prettier's GitHub page](https://github.com/prettier/prettier) for more information, and look at this [page to see it in action](https://prettier.github.io/prettier/).
312
313
314

To format our code whenever we make a commit in git, we need to install the following dependencies:

315
316
```sh
npm install --save husky lint-staged prettier
317
318
```

319
Alternatively you may use `yarn`:
320

321
322
```sh
yarn add husky lint-staged prettier
323
324
325
326
327
328
329
330
331
332
```

* `husky` makes it easy to use githooks as if they are npm scripts.
* `lint-staged` allows us to run scripts on staged files in git. See this [blog post about lint-staged to learn more about it](https://medium.com/@okonetchnikov/make-linting-great-again-f3890e1ad6b8).
* `prettier` is the JavaScript formatter we will run before commits.

Now we can make sure every file is formatted correctly by adding a few lines to the `package.json` in the project root.

Add the following line to `scripts` section:

333
```diff
334
  "scripts": {
335
336
337
+   "precommit": "lint-staged",
    "start": "react-scripts start",
    "build": "react-scripts build",
338
339
340
341
```

Next we add a 'lint-staged' field to the `package.json`, for example:

342
343
344
345
346
```diff
  "dependencies": {
    // ...
  },
+ "lint-staged": {
347
+   "src/**/*.{js,jsx,json,css}": [
348
349
350
351
352
+     "prettier --single-quote --write",
+     "git add"
+   ]
+ },
  "scripts": {
353
354
355
356
```

Now, whenever you make a commit, Prettier will format the changed files automatically. You can also run `./node_modules/.bin/prettier --single-quote --write "src/**/*.{js,jsx}"` to format your entire project for the first time.

357
Next you might want to integrate Prettier in your favorite editor. Read the section on [Editor Integration](https://prettier.io/docs/en/editors.html) on the Prettier GitHub page.
358

359
360
361
362
## Changing the Page `<title>`

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

363
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.
364
365
366

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.

367
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).
368

Dan Abramov's avatar
Dan Abramov committed
369
## Installing a Dependency
370
371
372

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`:

373
374
```sh
npm install --save react-router
375
376
```

377
Alternatively you may use `yarn`:
378

379
380
```sh
yarn add react-router
381
```
382
383

This works for any library, not just `react-router`.
384

Dan Abramov's avatar
Dan Abramov committed
385
## Importing a Component
Dan Abramov's avatar
Dan Abramov committed
386

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

For example:

Dan Abramov's avatar
Dan Abramov committed
392
### `Button.js`
Dan Abramov's avatar
Dan Abramov committed
393
394
395
396
397
398
399
400
401
402
403
404
405

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

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

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

Dan Abramov's avatar
Dan Abramov committed
406
407
### `DangerButton.js`

Dan Abramov's avatar
Dan Abramov committed
408
409
410
411
412
413
414

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

class DangerButton extends Component {
  render() {
415
    return <Button color="red" />;
Dan Abramov's avatar
Dan Abramov committed
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
  }
}

export default DangerButton;
```

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

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

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

Learn more about ES6 modules:

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

434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
## Code Splitting

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.

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.

Here is an example:

### `moduleA.js`

```js
const moduleA = 'Hello';

export { moduleA };
```
### `App.js`

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

class App extends Component {
  handleClick = () => {
    import('./moduleA')
      .then(({ moduleA }) => {
        // Use moduleA
      })
      .catch(err => {
        // Handle failure
      });
  };

  render() {
    return (
      <div>
        <button onClick={this.handleClick}>Load</button>
      </div>
    );
  }
}

export default App;
```

This will make `moduleA.js` and all its unique dependencies as a separate chunk that only loads after the user clicks the 'Load' button.

You can also use it with `async` / `await` syntax if you prefer it.

481
482
483
484
### With React Router

If you are using React Router check out [this tutorial](http://serverless-stack.com/chapters/code-splitting-in-create-react-app.html) on how to use code splitting with it. You can find the companion GitHub repository [here](https://github.com/AnomalyInnovations/serverless-stack-demo-client/tree/code-splitting-in-create-react-app).

Dan Abramov's avatar
Dan Abramov committed
485
486
Also check out the [Code Splitting](https://reactjs.org/docs/code-splitting.html) section in React documentation.

Dan Abramov's avatar
Dan Abramov committed
487
## Adding a Stylesheet
Dan Abramov's avatar
Dan Abramov committed
488

Joe Haddad's avatar
Joe Haddad committed
489
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**:
Dan Abramov's avatar
Dan Abramov committed
490

Dan Abramov's avatar
Dan Abramov committed
491
### `Button.css`
Dan Abramov's avatar
Dan Abramov committed
492
493
494
495
496
497
498

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

Dan Abramov's avatar
Dan Abramov committed
499
### `Button.js`
Dan Abramov's avatar
Dan Abramov committed
500
501
502
503
504
505
506
507

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

class Button extends Component {
  render() {
    // You can use them as regular CSS styles
508
    return <div className="Button" />;
Dan Abramov's avatar
Dan Abramov committed
509
510
511
512
  }
}
```

513
**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-blog/block-element-modifying-your-javascript-components-d7f99fcab52b). However you should be aware that this makes your code less portable to other build tools and environments than Webpack.
Dan Abramov's avatar
Dan Abramov committed
514

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

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

Joe Haddad's avatar
Joe Haddad committed
519
<!---
520
521
## Adding a CSS Modules stylesheet

522
This project supports [CSS Modules](https://github.com/css-modules/css-modules) alongside regular stylesheets using the **[name].module.css** file naming convention. CSS Modules allows the scoping of CSS by automatically creating a unique classname of the format **[filename]\_[classname]\_\_[hash]**.
523
524
525
526
527
528

An advantage of this is the ability to repeat the same classname within many CSS files without worrying about a clash.

### `Button.module.css`

```css
529
530
.error {
  background-color: red;
531
532
533
534
535
536
}
```

### `another-stylesheet.css`

```css
537
538
.error {
  color: red;
539
540
541
542
543
544
545
546
}
```

### `Button.js`

```js
import React, { Component } from 'react';
import styles from './Button.module.css'; // Import css modules stylesheet as styles
547
548
import './another-stylesheet.css'; // Import regular stylesheet

549
550
551

class Button extends Component {
  render() {
552
553
    // reference as a js object
    return <button className={styles.error}>Error Button</button>;
554
555
556
557
  }
}
```
### `exported HTML`
558
No clashes from other `.error` class names
559
560

```html
561
562
<!-- This button has red background but not red text -->
<button class="Button_error_ax7yz"></div>
563
564
```

565
**This is an optional feature.** Regular html stylesheets and js imported stylesheets are fully supported. CSS Modules are only added when explicitly named as a css module stylesheet using the extension `.module.css`.
566
-->
567

Dan Abramov's avatar
Dan Abramov committed
568
## Post-Processing CSS
Dan Abramov's avatar
Dan Abramov committed
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598

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

For example, this:

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

becomes this:

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

599
If you need to disable autoprefixing for some reason, [follow this section](https://github.com/postcss/autoprefixer#disabling).
Dan Abramov's avatar
Dan Abramov committed
600

601
602
603
604
605
606
607
608
## Adding a CSS Preprocessor (Sass, Less etc.)

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

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.

First, let’s install the command-line interface for Sass:

609
610
```sh
npm install --save node-sass-chokidar
611
```
612
613
614
615
616

Alternatively you may use `yarn`:

```sh
yarn add node-sass-chokidar
617
```
618

619
620
621
622
Then in `package.json`, add the following lines to `scripts`:

```diff
   "scripts": {
Kelly's avatar
Kelly committed
623
+    "build-css": "node-sass-chokidar src/ -o src/",
624
+    "watch-css": "node-sass-chokidar src/ -o src/ --watch",
625
626
627
628
629
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test --env=jsdom",
```

630
>Note: To use a different preprocessor, replace `build-css` and `watch-css` commands according to your preprocessor’s documentation.
631
632
633

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.

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

636
637
638
To enable importing files without using relative paths, you can add the  `--include-path` option to the command in `package.json`.

```
639
640
"build-css": "node-sass-chokidar --include-path ./node_modules src/ -o src/",
"watch-css": "node-sass-chokidar --include-path ./node_modules src/ -o src/ --watch",
641
642
643
644
645
646
647
648
649
```

This will allow you to do imports like

```scss
@import 'styles/_colors.scss'; // assuming a styles directory under src/
@import 'nprogress/nprogress'; // importing a css file from the nprogress node module
```

650
651
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.

652
653
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:

654
655
```sh
npm install --save npm-run-all
656
```
657
658
659
660
661

Alternatively you may use `yarn`:

```sh
yarn add npm-run-all
662
663
664
```

Then we can change `start` and `build` scripts to include the CSS preprocessor commands:
665
666
667

```diff
   "scripts": {
Kelly's avatar
Kelly committed
668
669
     "build-css": "node-sass-chokidar src/ -o src/",
     "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive",
670
671
-    "start": "react-scripts start",
-    "build": "react-scripts build",
672
673
+    "start-js": "react-scripts start",
+    "start": "npm-run-all -p watch-css start-js",
674
675
+    "build-js": "react-scripts build",
+    "build": "npm-run-all build-css build-js",
676
677
678
679
680
     "test": "react-scripts test --env=jsdom",
     "eject": "react-scripts eject"
   }
```

Joe Haddad's avatar
Joe Haddad committed
681
Now running `npm start` and `npm run build` also builds Sass files.
682

Kelly's avatar
Kelly committed
683
**Why `node-sass-chokidar`?**
684

Kelly's avatar
Kelly committed
685
`node-sass` has been reported as having the following issues:
686

Kelly's avatar
Kelly committed
687
- `node-sass --watch` has been reported to have *performance issues* in certain conditions when used in a virtual machine or with docker.
688

689
- Infinite styles compiling [#1939](https://github.com/facebook/create-react-app/issues/1939)
690

Kelly's avatar
Kelly committed
691
692
693
- `node-sass` has been reported as having issues with detecting new files in a directory [#1891](https://github.com/sass/node-sass/issues/1891)

 `node-sass-chokidar` is used here as it addresses these issues.
694

695
## Adding Images, Fonts, and Files
Dan Abramov's avatar
Dan Abramov committed
696
697
698

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

699
700
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.

701
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/facebook/create-react-app/issues/1153).
Dan Abramov's avatar
Dan Abramov committed
702
703
704
705
706
707
708

Here is an example:

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

709
console.log(logo); // /logo.84287d09.png
Dan Abramov's avatar
Dan Abramov committed
710
711
712
713
714
715

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

716
export default Header;
Dan Abramov's avatar
Dan Abramov committed
717
718
```

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

Dan Abramov's avatar
Dan Abramov committed
721
This works in CSS too:
Dan Abramov's avatar
Dan Abramov committed
722
723
724
725
726
727
728

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

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

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

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

736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
## Adding GraphQL files

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

If you are using GraphQL, you can **`import` GraphQL files in a JavaScript module**.

By importing GraphQL queries instead of using a [template tag](https://github.com/apollographql/graphql-tag), they are preprocessed at build time. This eliminates the need to process them on the client at run time. It also allows you to separate your GraphQL queries from your code. You can put a GraphQL query in a file with a `.graphql` extension.

Here is an example:

```js
// query.graphql
{
  githubStats(repository: "facebook/react") {
    stars
  }
}

// foo.js

import query from './query.graphql';

console.log(query);
// {
//   "kind": "Document",
// ...
```

Dan Abramov's avatar
Dan Abramov committed
764
765
766
767
## Using the `public` Folder

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

768
769
770
771
772
773
774
775
776
### Changing the HTML

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

### Adding Assets Outside of the Module System

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

777
Note that we normally encourage you to `import` assets in JavaScript files instead.
778
For example, see the sections on [adding a stylesheet](#adding-a-stylesheet) and [adding images and fonts](#adding-images-fonts-and-files).
779
This mechanism provides a number of benefits:
Dan Abramov's avatar
Dan Abramov committed
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796

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

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

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

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

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

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

Brian Ng's avatar
Brian Ng committed
797
When you run `npm run build`, Create React App will substitute `%PUBLIC_URL%` with a correct absolute path so your project works even if you use client-side routing or host it at a non-root URL.
Dan Abramov's avatar
Dan Abramov committed
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815

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

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

Keep in mind the downsides of this approach:

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

816
817
### When to Use the `public` Folder

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

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

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

828
## Using Global Variables
829
830
831
832
833
834
835
836
837
838
839
840
841

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

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

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

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

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

Dan Abramov's avatar
Dan Abramov committed
842
## Adding Bootstrap
843

844
You don’t have to use [reactstrap](https://reactstrap.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:
845

846
Install reactstrap and Bootstrap from npm. reactstrap does not include Bootstrap CSS so this needs to be installed as well:
847

848
```sh
849
npm install --save reactstrap bootstrap@4
850
```
851
852
853
854

Alternatively you may use `yarn`:

```sh
855
yarn add bootstrap@4 reactstrap 
856
857
```

858
Import Bootstrap CSS and optionally Bootstrap theme CSS in the beginning of your ```src/index.js``` file:
859

Dan Abramov's avatar
Dan Abramov committed
860
```js
861
import 'bootstrap/dist/css/bootstrap.css';
862
863
// Put any other imports below so that CSS from your
// components takes precedence over default styles.
864
865
```

866
Import required reactstrap components within ```src/App.js``` file or your custom component files:
867

Dan Abramov's avatar
Dan Abramov committed
868
```js
869
import { Button } from 'reactstrap';
870
```
871

872
Now you are ready to use the imported reactstrap components within your component hierarchy defined in the render method. Here is an example [`App.js`](https://gist.githubusercontent.com/zx6658/d9f128cd57ca69e583ea2b5fea074238/raw/a56701c142d0c622eb6c20a457fbc01d708cb485/App.js) redone using reactstrap.
873

874
875
876
877
878
879
880
881
882
883
884
### Using a Custom Theme

Sometimes you might need to tweak the visual styles of Bootstrap (or equivalent package).<br>
We suggest the following approach:

* Create a new package that depends on the package you wish to customize, e.g. Bootstrap.
* Add the necessary build steps to tweak the theme, and publish your package on npm.
* Install your own theme npm package as a dependency of your app.

Here is an example of adding a [customized Bootstrap](https://medium.com/@tacomanator/customizing-create-react-app-aa9ffb88165) that follows these steps.

Dan Abramov's avatar
Dan Abramov committed
885
## Adding Flow
886

887
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.
888

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

891
To add Flow to a Create React App project, follow these steps:
892

893
1. Run `npm install --save flow-bin` (or `yarn add flow-bin`).
894
2. Add `"flow": "flow"` to the `scripts` section of your `package.json`.
Khang Lu's avatar
Khang Lu committed
895
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.
896
4. Add `// @flow` to any files you want to type check (for example, to `src/App.js`).
897

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

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

904
905
906
907
908
909
910
## Adding a Router

Create React App doesn't prescribe a specific routing solution, but [React Router](https://reacttraining.com/react-router/) is the most popular one.

To add it, run:

```sh
Dan Abramov's avatar
Dan Abramov committed
911
npm install --save react-router-dom
912
913
914
915
916
```

Alternatively you may use `yarn`:

```sh
Dan Abramov's avatar
Dan Abramov committed
917
yarn add react-router-dom
918
919
920
921
922
923
```

To try it, delete all the code in `src/App.js` and replace it with any of the examples on its website. The [Basic Example](https://reacttraining.com/react-router/web/example/basic) is a good place to get started.

Note that [you may need to configure your production server to support client-side routing](#serving-apps-with-client-side-routing) before deploying your app.

Dan Abramov's avatar
Dan Abramov committed
924
## Adding Custom Environment Variables
925

Dan Abramov's avatar
Dan Abramov committed
926
>Note: this feature is available with `react-scripts@0.2.3` and higher.
927
928
929

Your project can consume variables declared in your environment as if they were declared locally in your JS files. By
default you will have `NODE_ENV` defined for you, and any other environment variables starting with
930
931
`REACT_APP_`.

932
933
**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.

934
>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/facebook/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running.
935
936

These environment variables will be defined for you on `process.env`. For example, having an environment
937
variable named `REACT_APP_SECRET_CODE` will be exposed in your JS as `process.env.REACT_APP_SECRET_CODE`.
938

939
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.
940

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

944
945
First, you need to have environment variables defined. For example, let’s say you wanted to consume a secret defined
in the environment inside a `<form>`:
946
947

```jsx
Dan Abramov's avatar
Dan Abramov committed
948
949
950
951
952
953
954
955
956
957
render() {
  return (
    <div>
      <small>You are running this application in <b>{process.env.NODE_ENV}</b> mode.</small>
      <form>
        <input type="hidden" defaultValue={process.env.REACT_APP_SECRET_CODE} />
      </form>
    </div>
  );
}
958
959
```

960
961
962
963
964
965
966
967
968
969
970
971
972
During the build, `process.env.REACT_APP_SECRET_CODE` will be replaced with the current value of the `REACT_APP_SECRET_CODE` environment variable. Remember that the `NODE_ENV` variable will be set for you automatically.

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

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

973
974
975
976
The above form is looking for a variable called `REACT_APP_SECRET_CODE` from the environment. In order to consume this
value, we need to have it defined in the environment. This can be done using two ways: either in your shell or in
a `.env` file. Both of these ways are described in the next few sections.

977
978
979
980
981
982
983
984
Having access to the `NODE_ENV` is also useful for performing actions conditionally:

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

985
When you compile the app with `npm run build`, the minification step will strip out this condition, and the resulting bundle will be smaller.
986

987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### Referencing Environment Variables in the HTML

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

You can also access the environment variables starting with `REACT_APP_` in the `public/index.html`. For example:

```html
<title>%REACT_APP_WEBSITE_NAME%</title>
```

Note that the caveats from the above section apply:

* Apart from a few built-in variables (`NODE_ENV` and `PUBLIC_URL`), variable names must start with `REACT_APP_` to work.
* 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).
For faster browsing, not all history is shown. View entire blame