README.md 118 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)
Joe Haddad's avatar
Joe Haddad committed
17
- [Supported Language Features](#supported-language-features)
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
- [Adding a Stylesheet](#adding-a-stylesheet)
27
- [Adding a CSS Modules stylesheet](#adding-a-css-modules-stylesheet)
Joe Haddad's avatar
Joe Haddad committed
28
- [Adding a Sass stylesheet](#adding-a-sass-stylesheet)
Dan Abramov's avatar
Dan Abramov committed
29
- [Post-Processing CSS](#post-processing-css)
30
- [Adding Images, Fonts, and Files](#adding-images-fonts-and-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
- [Using HTTPS in Development](#using-https-in-development)
Dan Abramov's avatar
Dan Abramov committed
53
- [Generating Dynamic `<meta>` Tags on the Server](#generating-dynamic-meta-tags-on-the-server)
54
- [Pre-Rendering into Static HTML Files](#pre-rendering-into-static-html-files)
55
- [Injecting Data from the Server into the Page](#injecting-data-from-the-server-into-the-page)
Dan Abramov's avatar
Dan Abramov committed
56
57
58
59
60
61
62
- [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)
63
  - [Initializing Test Environment](#initializing-test-environment)
64
  - [Focusing and Excluding Tests](#focusing-and-excluding-tests)
Dan Abramov's avatar
Dan Abramov committed
65
66
67
  - [Coverage Reporting](#coverage-reporting)
  - [Continuous Integration](#continuous-integration)
  - [Disabling jsdom](#disabling-jsdom)
68
  - [Snapshot Testing](#snapshot-testing)
Orta's avatar
Orta committed
69
  - [Editor Integration](#editor-integration)
70
- [Debugging Tests](#debugging-tests)
Dan Abramov's avatar
Dan Abramov committed
71
72
  - [Debugging Tests in Chrome](#debugging-tests-in-chrome)
  - [Debugging Tests in Visual Studio Code](#debugging-tests-in-visual-studio-code)
73
74
75
- [Developing Components in Isolation](#developing-components-in-isolation)
  - [Getting Started with Storybook](#getting-started-with-storybook)
  - [Getting Started with Styleguidist](#getting-started-with-styleguidist)
Dan Abramov's avatar
Dan Abramov committed
76
- [Publishing Components to npm](#publishing-components-to-npm)
Dan Abramov's avatar
Dan Abramov committed
77
- [Making a Progressive Web App](#making-a-progressive-web-app)
78
  - [Why Opt-in?](#why-opt-in)
79
80
  - [Offline-First Considerations](#offline-first-considerations)
  - [Progressive Web App Metadata](#progressive-web-app-metadata)
81
- [Analyzing the Bundle Size](#analyzing-the-bundle-size)
82
- [Deployment](#deployment)
83
84
  - [Static Server](#static-server)
  - [Other Solutions](#other-solutions)
85
  - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing)
86
  - [Building for Relative Paths](#building-for-relative-paths)
87
  - [Customizing Environment Variables for Arbitrary Build Environments](#customizing-environment-variables-for-arbitrary-build-environments)
88
  - [Azure](#azure)
89
  - [Firebase](#firebase)
90
  - [GitHub Pages](#github-pages)
91
  - [Heroku](#heroku)
92
  - [Netlify](#netlify)
93
  - [Now](#now)
94
  - [S3 and CloudFront](#s3-and-cloudfront)
95
  - [Surge](#surge)
96
- [Advanced Configuration](#advanced-configuration)
97
- [Troubleshooting](#troubleshooting)
98
  - [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes)
99
  - [`npm test` hangs or crashes on macOS Sierra](#npm-test-hangs-or-crashes-on-macos-sierra)
100
  - [`npm run build` exits too early](#npm-run-build-exits-too-early)
101
  - [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku)
102
  - [`npm run build` fails to minify](#npm-run-build-fails-to-minify)
103
  - [Moment.js locales are missing](#momentjs-locales-are-missing)
104
- [Alternatives to Ejecting](#alternatives-to-ejecting)
Dan Abramov's avatar
Dan Abramov committed
105
- [Something Missing?](#something-missing)
Manav Sehgal's avatar
Manav Sehgal committed
106

Dan Abramov's avatar
Dan Abramov committed
107
108
109
110
## Updating to New Releases

Create React App is divided into two packages:

Joe Haddad's avatar
Joe Haddad committed
111
112
- `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).
Dan Abramov's avatar
Dan Abramov committed
113

Vadim Peretokin's avatar
Vadim Peretokin committed
114
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
115
116
117

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.

118
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
119

Joe Haddad's avatar
Joe Haddad committed
120
In most cases bumping the `react-scripts` version in `package.json` and running `npm install` (or `yarn 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
121
122
123

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

Dan Abramov's avatar
Dan Abramov committed
124
125
## Sending Feedback

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

128
129
## Folder Structure

130
After creation, your project should look like this:
131
132
133
134
135
136

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

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

Joe Haddad's avatar
Joe Haddad committed
151
152
- `public/index.html` is the page template;
- `src/index.js` is the JavaScript entry point.
153
154
155

You can delete or rename the other files.

Dan Abramov's avatar
Dan Abramov committed
156
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
157
You need to **put any JS and CSS files inside `src`**, otherwise Webpack won’t see them.
158

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

Dan Abramov's avatar
Dan Abramov committed
162
You can, however, create more top-level directories.<br>
163
164
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
165
166
## Available Scripts

167
In the project directory, you can run:
168
169
170
171
172
173
174
175
176

### `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
177
178
### `npm test`

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

182
183
184
185
186
187
188
189
### `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!

190
191
See the section about [deployment](#deployment) for more information.

192
193
194
195
196
197
### `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.

198
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.
199
200

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
201

202
203
## Supported Browsers

Joe Haddad's avatar
Joe Haddad committed
204
205
By default, the generated project supports all modern browsers.<br>
Support for Internet Explorer 9, 10, and 11 requires [polyfills](https://github.com/facebook/create-react-app/blob/next/packages/react-app-polyfill/README.md).
206

Joe Haddad's avatar
Joe Haddad committed
207
### Supported Language Features
208

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

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

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

221
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.
222

223
Note that **this project includes no [polyfills](https://github.com/facebook/create-react-app/blob/next/packages/react-app-polyfill/README.md)** by default.
224

225
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.
226

227
228
## Syntax Highlighting in the Editor

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

Dan Abramov's avatar
Dan Abramov committed
231
## Displaying Lint Output in the Editor
Dan Abramov's avatar
Dan Abramov committed
232

Joe Haddad's avatar
Joe Haddad committed
233
234
> Note: this feature is available with `react-scripts@0.2.0` and higher.<br>
> It also only works with npm 3 or higher.
Dan Abramov's avatar
Dan Abramov committed
235
236
237
238
239

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.

240
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
241
242
243

```js
{
244
  "extends": "react-app"
Dan Abramov's avatar
Dan Abramov committed
245
246
247
}
```

248
Now your editor should report the linting warnings.
Dan Abramov's avatar
Dan Abramov committed
249

Lufty Wiranda's avatar
Lufty Wiranda committed
250
251
252
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
253

254
255
## Debugging in the Editor

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

258
259
260
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
261
262
263
264
265
266
267
268

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",
Joe Haddad's avatar
Joe Haddad committed
269
270
271
272
273
274
275
276
277
278
  "configurations": [
    {
      "name": "Chrome",
      "type": "chrome",
      "request": "launch",
      "url": "http://localhost:3000",
      "webRoot": "${workspaceRoot}/src",
      "sourceMapPathOverrides": {
        "webpack:///src/*": "${webRoot}/*"
      }
279
    }
Joe Haddad's avatar
Joe Haddad committed
280
  ]
281
282
}
```
Joe Haddad's avatar
Joe Haddad committed
283
284

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

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.

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

290
291
292
293
294
295
### 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.

Joe Haddad's avatar
Joe Haddad committed
296
> Note: the URL may be different if you've made adjustments via the [HOST or PORT environment variables](#advanced-configuration).
297
298
299

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.

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

302
303
## Formatting Code Automatically

304
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/).
305
306
307

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

308
309
```sh
npm install --save husky lint-staged prettier
310
311
```

312
Alternatively you may use `yarn`:
313

314
315
```sh
yarn add husky lint-staged prettier
316
317
```

Joe Haddad's avatar
Joe Haddad committed
318
319
320
- `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.
321
322
323

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

324
Add the following field to the `package.json` section:
325

326
```diff
327
328
329
330
331
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  }
332
333
334
335
```

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

336
337
338
339
340
```diff
  "dependencies": {
    // ...
  },
+ "lint-staged": {
341
+   "src/**/*.{js,jsx,json,css}": [
342
343
344
345
346
+     "prettier --single-quote --write",
+     "git add"
+   ]
+ },
  "scripts": {
347
348
349
350
```

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.

351
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.
352

353
354
355
356
## 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.

357
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.
358
359
360

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.

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

Dan Abramov's avatar
Dan Abramov committed
363
## Installing a Dependency
364
365
366

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

367
```sh
Joe Haddad's avatar
Joe Haddad committed
368
npm install --save react-router-dom
369
370
```

371
Alternatively you may use `yarn`:
372

373
```sh
Joe Haddad's avatar
Joe Haddad committed
374
yarn add react-router-dom
375
```
376

Joe Haddad's avatar
Joe Haddad committed
377
This works for any library, not just `react-router-dom`.
378

Dan Abramov's avatar
Dan Abramov committed
379
## Importing a Component
Dan Abramov's avatar
Dan Abramov committed
380

Joe Haddad's avatar
Joe Haddad committed
381
This project setup supports ES6 modules thanks to Webpack.<br>
Dan Abramov's avatar
Dan Abramov committed
382
383
384
385
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
386
### `Button.js`
Dan Abramov's avatar
Dan Abramov committed
387
388
389
390
391
392
393
394
395
396
397
398
399

```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
400
401
### `DangerButton.js`

Dan Abramov's avatar
Dan Abramov committed
402
403
404
405
406
407
```js
import React, { Component } from 'react';
import Button from './Button'; // Import a component from another file

class DangerButton extends Component {
  render() {
408
    return <Button color="red" />;
Dan Abramov's avatar
Dan Abramov committed
409
410
411
412
413
414
415
416
417
418
419
420
421
422
  }
}

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:

Joe Haddad's avatar
Joe Haddad committed
423
424
425
- [When to use the curly braces?](http://stackoverflow.com/questions/36795819/react-native-es-6-when-should-i-use-curly-braces-for-import/36796281#36796281)
- [Exploring ES6: Modules](http://exploringjs.com/es6/ch_modules.html)
- [Understanding ES6: Modules](https://leanpub.com/understandinges6/read#leanpub-auto-encapsulating-code-with-modules)
Dan Abramov's avatar
Dan Abramov committed
426

427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
## 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 };
```
Joe Haddad's avatar
Joe Haddad committed
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
### `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.

475
476
477
478
### 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
479
480
Also check out the [Code Splitting](https://reactjs.org/docs/code-splitting.html) section in React documentation.

Dan Abramov's avatar
Dan Abramov committed
481
## Adding a Stylesheet
Dan Abramov's avatar
Dan Abramov committed
482

Joe Haddad's avatar
Joe Haddad committed
483
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
484

Dan Abramov's avatar
Dan Abramov committed
485
### `Button.css`
Dan Abramov's avatar
Dan Abramov committed
486
487
488
489
490
491
492

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

Dan Abramov's avatar
Dan Abramov committed
493
### `Button.js`
Dan Abramov's avatar
Dan Abramov committed
494
495
496
497
498
499
500
501

```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
502
    return <div className="Button" />;
Dan Abramov's avatar
Dan Abramov committed
503
504
505
506
  }
}
```

507
**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
508

Dan Abramov's avatar
Dan Abramov committed
509
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
510

511
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
512

513
514
## Adding a CSS Modules stylesheet

Joe Haddad's avatar
Joe Haddad committed
515
516
> Note: this feature is available with `react-scripts@2.0.0` and higher.

517
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]**.
518

Joe Haddad's avatar
Joe Haddad committed
519
> **Tip:** Should you want to preprocess a stylesheet with Sass then make sure to [follow the installation instructions](#adding-a-sass-stylesheet) and then change the stylesheet file extension as follows: _[name].module.scss_ or _[name].module.sass_.
520

521
522
523
524
525
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
526
527
.error {
  background-color: red;
528
529
530
531
532
533
}
```

### `another-stylesheet.css`

```css
534
535
.error {
  color: red;
536
537
538
539
540
541
542
543
}
```

### `Button.js`

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

546
547
class Button extends Component {
  render() {
548
549
    // reference as a js object
    return <button className={styles.error}>Error Button</button>;
550
551
552
  }
}
```
Joe Haddad's avatar
Joe Haddad committed
553

554
### `exported HTML`
Joe Haddad's avatar
Joe Haddad committed
555

556
No clashes from other `.error` class names
557
558

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

563
**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`.
564

Joe Haddad's avatar
Joe Haddad committed
565
566
## Adding a Sass stylesheet

Joe Haddad's avatar
Joe Haddad committed
567
568
> Note: this feature is available with `react-scripts@2.0.0` and higher.

Joe Haddad's avatar
Joe Haddad committed
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
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.

To use Sass, first install `node-sass`:

```bash
$ npm install node-sass --save
$ # or
$ yarn add node-sass
```

Now you can rename `src/App.css` to `src/App.scss` and update `src/App.js` to import `src/App.scss`.
This file and any other file will be automatically compiled if imported with the extension `.scss` or `.sass`.

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.

This will allow you to do imports like

```scss
@import 'styles/_colors.scss'; // assuming a styles directory under src/
Joe Haddad's avatar
Joe Haddad committed
590
@import '~nprogress/nprogress'; // importing a css file from the nprogress node module
Joe Haddad's avatar
Joe Haddad committed
591
592
```

593
594
> **Tip:** You can opt into using this feature with [CSS modules](#adding-a-css-modules-stylesheet) too!

Dan Abramov's avatar
Dan Abramov committed
595
## Post-Processing CSS
Dan Abramov's avatar
Dan Abramov committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617

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;
Joe Haddad's avatar
Joe Haddad committed
618
619
  -ms-flex-direction: row;
  flex-direction: row;
Dan Abramov's avatar
Dan Abramov committed
620
  -webkit-box-align: center;
Joe Haddad's avatar
Joe Haddad committed
621
622
  -ms-flex-align: center;
  align-items: center;
Dan Abramov's avatar
Dan Abramov committed
623
624
625
}
```

626
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
627

628
629
630
631
[CSS Grid Layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Grid_Layout) prefixing is disabled by default, but it will **not** strip manual prefixing.
If you'd like to opt-in to CSS Grid prefixing, [first familiarize yourself about its limitations](https://github.com/postcss/autoprefixer#does-autoprefixer-polyfill-grid-layout-for-ie).<br>
To enable CSS Grid prefixing, add `/* autoprefixer grid: on */` to the top of your CSS file.

632
## Adding Images, Fonts, and Files
Dan Abramov's avatar
Dan Abramov committed
633
634
635

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

636
637
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.

638
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
639
640
641
642
643
644
645

Here is an example:

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

646
console.log(logo); // /logo.84287d09.png
Dan Abramov's avatar
Dan Abramov committed
647
648
649
650
651
652

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

653
export default Header;
Dan Abramov's avatar
Dan Abramov committed
654
655
```

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

Dan Abramov's avatar
Dan Abramov committed
658
This works in CSS too:
Dan Abramov's avatar
Dan Abramov committed
659
660
661
662
663
664
665

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

666
667
668
669
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
670
**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
671
672
673
674
An alternative way of handling static assets is described in the next section.

## Using the `public` Folder

Joe Haddad's avatar
Joe Haddad committed
675
> Note: this feature is available with `react-scripts@0.5.0` and higher.
Dan Abramov's avatar
Dan Abramov committed
676

677
678
679
680
681
682
683
684
685
### 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.

686
Note that we normally encourage you to `import` assets in JavaScript files instead.
687
For example, see the sections on [adding a stylesheet](#adding-a-stylesheet) and [adding images and fonts](#adding-images-fonts-and-files).
688
This mechanism provides a number of benefits:
Dan Abramov's avatar
Dan Abramov committed
689

Joe Haddad's avatar
Joe Haddad committed
690
691
692
- 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.
Dan Abramov's avatar
Dan Abramov committed
693
694
695

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

Joe Haddad's avatar
Joe Haddad committed
696
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`.
Dan Abramov's avatar
Dan Abramov committed
697
698
699
700
701
702
703
704
705

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
706
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
707
708
709
710
711
712
713
714
715
716
717
718
719
720

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:

Joe Haddad's avatar
Joe Haddad committed
721
722
723
- 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.
Dan Abramov's avatar
Dan Abramov committed
724

725
726
### When to Use the `public` Folder

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

Joe Haddad's avatar
Joe Haddad committed
730
731
732
733
- 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.
734

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

737
## Using Global Variables
738
739
740
741
742
743
744
745
746
747
748
749
750

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
751
## Adding Bootstrap
752

753
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:
754

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

757
```sh
758
npm install --save reactstrap bootstrap@4
759
```
760
761
762
763

Alternatively you may use `yarn`:

```sh
764
yarn add bootstrap@4 reactstrap
765
766
```

Joe Haddad's avatar
Joe Haddad committed
767
Import Bootstrap CSS and optionally Bootstrap theme CSS in the beginning of your `src/index.js` file:
768

Dan Abramov's avatar
Dan Abramov committed
769
```js
770
import 'bootstrap/dist/css/bootstrap.css';
771
772
// Put any other imports below so that CSS from your
// components takes precedence over default styles.
773
774
```

Joe Haddad's avatar
Joe Haddad committed
775
Import required reactstrap components within `src/App.js` file or your custom component files:
776

Dan Abramov's avatar
Dan Abramov committed
777
```js
778
import { Button } from 'reactstrap';
779
```
780

781
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.
782

783
784
785
786
787
### Using a Custom Theme

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

Joe Haddad's avatar
Joe Haddad committed
788
789
790
- 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.
791
792
793

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
794
## Adding Flow
795

796
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.
797

798
Recent versions of [Flow](https://flow.org/) work with Create React App projects out of the box.
799

800
To add Flow to a Create React App project, follow these steps:
801

802
1. Run `npm install --save flow-bin` (or `yarn add flow-bin`).
803
2. Add `"flow": "flow"` to the `scripts` section of your `package.json`.
804
3. Run `npm run flow init` (or `yarn flow init`) to create a [`.flowconfig` file](https://flow.org/en/docs/config/) in the root directory.
805
4. Add `// @flow` to any files you want to type check (for example, to `src/App.js`).
806

807
Now you can run `npm run flow` (or `yarn flow`) to check the files for type errors.
808
809
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.
810

811
To learn more about Flow, check out [its documentation](https://flow.org/).
812

813
814
## Adding a Router

Joe Haddad's avatar
Joe Haddad committed
815
Create React App doesn't prescribe a specific routing solution, but [React Router](https://reacttraining.com/react-router/web/) is the most popular one.
816
817
818
819

To add it, run:

```sh
Dan Abramov's avatar
Dan Abramov committed
820
npm install --save react-router-dom
821
822
823
824
825
```

Alternatively you may use `yarn`:

```sh
Dan Abramov's avatar
Dan Abramov committed
826
yarn add react-router-dom
827
828
829
830
831
832
```

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
833
## Adding Custom Environment Variables
834

Joe Haddad's avatar
Joe Haddad committed
835
> Note: this feature is available with `react-scripts@0.2.3` and higher.
836
837
838

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
839
840
`REACT_APP_`.

841
842
**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.

Joe Haddad's avatar
Joe Haddad committed
843
> 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.
844
845

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

848
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.
849

850
851
852
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.

853
854
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>`:
855
856

```jsx
Dan Abramov's avatar
Dan Abramov committed
857
858
859
860
861
862
863
864
865
866
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>
  );
}
867
868
```

869
870
871
872
873
874
875
876
877
878
879
880
881
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>
```

882
883
884
885
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.

886
887
888
889
890
891
892
893
Having access to the `NODE_ENV` is also useful for performing actions conditionally:

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

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

896
897
### Referencing Environment Variables in the HTML

Joe Haddad's avatar
Joe Haddad committed
898
> Note: this feature is available with `react-scripts@0.9.0` and higher.
899
900
901
902
903
904
905
906
907

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:

Joe Haddad's avatar
Joe Haddad committed
908
909
- 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).
910

911
912
### Adding Temporary Environment Variables In Your Shell

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

Dan Abramov's avatar
Dan Abramov committed
916
#### Windows (cmd.exe)
917
918

```cmd
919
set "REACT_APP_SECRET_CODE=abcdef" && npm start
920
921
```

922
(Note: Quotes around the variable assignment are required to avoid a trailing whitespace.)
Dan Abramov's avatar
Dan Abramov committed
923

924
925
926
927
928
929
#### Windows (Powershell)

```Powershell
($env:REACT_APP_SECRET_CODE = "abcdef") -and (npm start)
```

930
#### Linux, macOS (Bash)
931
932
933
934
935

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

936
### Adding Development Environment Variables In `.env`
937

Joe Haddad's avatar
Joe Haddad committed
938
> Note: this feature is available with `react-scripts@0.5.0` and higher.
939

Brian Ng's avatar
Brian Ng committed
940
To define permanent environment variables, create a file called `.env` in the root of your project:
941
942
943

```
REACT_APP_SECRET_CODE=abcdef
944
```
Joe Haddad's avatar
Joe Haddad committed
945
946

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

Joe Haddad's avatar
Joe Haddad committed
948
949
`.env` files **should be** checked into source control (with the exclusion of `.env*.local`).

Ryan Swapp's avatar
Ryan Swapp committed
950
#### What other `.env` files can be used?
Joe Haddad's avatar
Joe Haddad committed
951

Joe Haddad's avatar
Joe Haddad committed
952
> Note: this feature is **available with `react-scripts@1.0.0` and higher**.
953

Joe Haddad's avatar
Joe Haddad committed
954
955
956
957
- `.env`: Default.
- `.env.local`: Local overrides. **This file is loaded for all environments except test.**
- `.env.development`, `.env.test`, `.env.production`: Environment-specific settings.
- `.env.development.local`, `.env.test.local`, `.env.production.local`: Local overrides of environment-specific settings.
958

959
Files on the left have more priority than files on the right:
960

Joe Haddad's avatar
Joe Haddad committed
961
962
963
- `npm start`: `.env.development.local`, `.env.development`, `.env.local`, `.env`
- `npm run build`: `.env.production.local`, `.env.production`, `.env.local`, `.env`
- `npm test`: `.env.test.local`, `.env.test`, `.env` (note `.env.local` is missing)
964

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

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

971
972
#### Expanding Environment Variables In `.env`

Joe Haddad's avatar
Joe Haddad committed
973
> Note: this feature is available with `react-scripts@1.1.0` and higher.
974

975
Expand variables already on your machine for use in your `.env` file (using [dotenv-expand](https://github.com/motdotla/dotenv-expand)).
976
977

For example, to get the environment variable `npm_package_version`:
978

979
980
981
982
983
```
REACT_APP_VERSION=$npm_package_version
# also works:
# REACT_APP_VERSION=${npm_package_version}
```
984

985
Or expand variables local to the current `.env` file:
986

987
988
989
990
991
992
```
DOMAIN=www.example.com
REACT_APP_FOO=$DOMAIN/foo
REACT_APP_BAR=$DOMAIN/bar
```

Dan Abramov's avatar
Dan Abramov committed
993
994
## Can I Use Decorators?

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

Joe Haddad's avatar
Joe Haddad committed
998
999
1000
- It is an experimental proposal and is subject to change.
- The current specification version is not officially supported by Babel.
- If the specification changes, we won’t be able to write a codemod because we don’t use them internally at Facebook.
For faster browsing, not all history is shown. View entire blame