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

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

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

Dan Abramov's avatar
Dan Abramov committed
8
- [Updating to New Releases](#updating-to-new-releases)
Manav Sehgal's avatar
Manav Sehgal committed
9
10
11
- [Sending Feedback](#sending-feedback)
- [Folder Structure](#folder-structure)
- [Available Scripts](#available-scripts)
12
  - [npm start](#npm-start)
Dan Abramov's avatar
Dan Abramov committed
13
  - [npm test](#npm-test)
14
15
  - [npm run build](#npm-run-build)
  - [npm run eject](#npm-run-eject)
16
- [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)
Dan Abramov's avatar
Dan Abramov committed
30
- [Using the `public` Folder](#using-the-public-folder)
31
32
33
  - [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)
34
- [Using Global Variables](#using-global-variables)
Dan Abramov's avatar
Dan Abramov committed
35
- [Adding Bootstrap](#adding-bootstrap)
36
  - [Using a Custom Theme](#using-a-custom-theme)
Dan Abramov's avatar
Dan Abramov committed
37
- [Adding Flow](#adding-flow)
38
- [Adding a Router](#adding-a-router)
Dan Abramov's avatar
Dan Abramov committed
39
- [Adding Custom Environment Variables](#adding-custom-environment-variables)
40
41
42
  - [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
43
- [Can I Use Decorators?](#can-i-use-decorators)
44
45
46
- [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
47
- [Proxying API Requests in Development](#proxying-api-requests-in-development)
48
  - ["Invalid Host Header" Errors After Configuring Proxy](#invalid-host-header-errors-after-configuring-proxy)
Joe Haddad's avatar
Joe Haddad committed
49
  - [Configuring the Proxy Manually](#configuring-the-proxy-manually)
50
  - [Configuring a WebSocket Proxy](#configuring-a-websocket-proxy)
51
- [Using HTTPS in Development](#using-https-in-development)
Dan Abramov's avatar
Dan Abramov committed
52
- [Generating Dynamic `<meta>` Tags on the Server](#generating-dynamic-meta-tags-on-the-server)
53
- [Pre-Rendering into Static HTML Files](#pre-rendering-into-static-html-files)
54
- [Injecting Data from the Server into the Page](#injecting-data-from-the-server-into-the-page)
Dan Abramov's avatar
Dan Abramov committed
55
56
57
58
59
60
61
- [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)
62
  - [Initializing Test Environment](#initializing-test-environment)
63
  - [Focusing and Excluding Tests](#focusing-and-excluding-tests)
Dan Abramov's avatar
Dan Abramov committed
64
65
66
  - [Coverage Reporting](#coverage-reporting)
  - [Continuous Integration](#continuous-integration)
  - [Disabling jsdom](#disabling-jsdom)
67
  - [Snapshot Testing](#snapshot-testing)
Orta's avatar
Orta committed
68
  - [Editor Integration](#editor-integration)
69
- [Debugging Tests](#debugging-tests)
70
71
72
- [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
73
- [Publishing Components to npm](#publishing-components-to-npm)
Dan Abramov's avatar
Dan Abramov committed
74
- [Making a Progressive Web App](#making-a-progressive-web-app)
75
  - [Opting Out of Caching](#opting-out-of-caching)
76
77
  - [Offline-First Considerations](#offline-first-considerations)
  - [Progressive Web App Metadata](#progressive-web-app-metadata)
78
- [Analyzing the Bundle Size](#analyzing-the-bundle-size)
79
- [Deployment](#deployment)
80
81
  - [Static Server](#static-server)
  - [Other Solutions](#other-solutions)
82
  - [Serving Apps with Client-Side Routing](#serving-apps-with-client-side-routing)
83
  - [Building for Relative Paths](#building-for-relative-paths)
84
  - [Azure](#azure)
85
  - [Firebase](#firebase)
86
  - [GitHub Pages](#github-pages)
87
  - [Heroku](#heroku)
88
  - [Netlify](#netlify)
89
  - [Now](#now)
90
  - [S3 and CloudFront](#s3-and-cloudfront)
91
  - [Surge](#surge)
92
- [Advanced Configuration](#advanced-configuration)
93
- [Troubleshooting](#troubleshooting)
94
  - [`npm start` doesn’t detect changes](#npm-start-doesnt-detect-changes)
95
  - [`npm test` hangs on macOS Sierra](#npm-test-hangs-on-macos-sierra)
96
  - [`npm run build` exits too early](#npm-run-build-exits-too-early)
97
  - [`npm run build` fails on Heroku](#npm-run-build-fails-on-heroku)
98
  - [`npm run build` fails to minify](#npm-run-build-fails-to-minify)
99
  - [Moment.js locales are missing](#momentjs-locales-are-missing)
100
- [Alternatives to Ejecting](#alternatives-to-ejecting)
Dan Abramov's avatar
Dan Abramov committed
101
- [Something Missing?](#something-missing)
Manav Sehgal's avatar
Manav Sehgal committed
102

Dan Abramov's avatar
Dan Abramov committed
103
104
105
106
107
108
109
## 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
110
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
111
112
113
114
115
116
117
118
119

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

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

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

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

Dan Abramov's avatar
Dan Abramov committed
120
121
122
123
## Sending Feedback

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

124
125
## Folder Structure

126
After creation, your project should look like this:
127
128
129
130
131
132

```
my-app/
  README.md
  node_modules/
  package.json
Dan Abramov's avatar
Dan Abramov committed
133
134
135
  public/
    index.html
    favicon.ico
136
137
138
  src/
    App.css
    App.js
139
    App.test.js
140
141
142
143
144
145
146
    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
147
* `public/index.html` is the page template;
148
149
150
151
* `src/index.js` is the JavaScript entry point.

You can delete or rename the other files.

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

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

Dan Abramov's avatar
Dan Abramov committed
158
You can, however, create more top-level directories.<br>
159
160
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
161
162
## Available Scripts

163
In the project directory, you can run:
164
165
166
167
168
169
170
171
172

### `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
173
174
### `npm test`

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

178
179
180
181
182
183
184
185
### `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!

186
187
See the section about [deployment](#deployment) for more information.

188
189
190
191
192
193
### `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.

194
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.
195
196

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
197

198
199
200
201
202
203
## 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.

204
205
## Supported Language Features and Polyfills

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

Dan Abramov's avatar
Dan Abramov committed
209
210
* [Exponentiation Operator](https://github.com/rwaldron/exponentiation-operator) (ES2016).
* [Async/await](https://github.com/tc39/ecmascript-asyncawait) (ES2017).
211
* [Object Rest/Spread Properties](https://github.com/sebmarkbage/ecmascript-rest-spread) (stage 3 proposal).
212
* [Dynamic import()](https://github.com/tc39/proposal-dynamic-import) (stage 3 proposal)
213
* [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
214
* [JSX](https://facebook.github.io/react/docs/introducing-jsx.html) and [Flow](https://flowtype.org/) syntax.
215
216
217

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

218
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.
219
220
221
222
223
224
225

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

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

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

230
231
## Syntax Highlighting in the Editor

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

Dan Abramov's avatar
Dan Abramov committed
234
## Displaying Lint Output in the Editor
Dan Abramov's avatar
Dan Abramov committed
235

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

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.

243
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
244
245
246

```js
{
247
  "extends": "react-app"
Dan Abramov's avatar
Dan Abramov committed
248
249
250
}
```

251
Now your editor should report the linting warnings.
Dan Abramov's avatar
Dan Abramov committed
252

Lufty Wiranda's avatar
Lufty Wiranda committed
253
254
255
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
256

257
258
## Debugging in the Editor

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

261
262
263
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

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}/*"
    }
  }]
}
```
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
296
297
298
299
300
301
### 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.

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

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
318
319
320
321
322
323
324
325
```

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

326
```diff
327
  "scripts": {
328
329
330
+   "precommit": "lint-staged",
    "start": "react-scripts start",
    "build": "react-scripts build",
331
332
333
334
```

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

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

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.

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

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

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

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.

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

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

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

366
367
```sh
npm install --save react-router
368
369
```

370
Alternatively you may use `yarn`:
371

372
373
```sh
yarn add react-router
374
```
375
376

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

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

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

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

Dan Abramov's avatar
Dan Abramov committed
401
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
423
424
425
426
  }
}

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)

427
428
429
430
431
432
433
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
## 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.

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

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

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

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

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

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

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

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

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

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

Dan Abramov's avatar
Dan Abramov committed
512
## Post-Processing CSS
Dan Abramov's avatar
Dan Abramov committed
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542

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;
}
```

543
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
544

545
546
547
548
549
550
551
552
## 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:

553
554
```sh
npm install --save node-sass-chokidar
555
```
556
557
558
559
560

Alternatively you may use `yarn`:

```sh
yarn add node-sass-chokidar
561
```
562

563
564
565
566
Then in `package.json`, add the following lines to `scripts`:

```diff
   "scripts": {
Kelly's avatar
Kelly committed
567
568
+    "build-css": "node-sass-chokidar src/ -o src/",
+    "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive",
569
570
571
572
573
     "start": "react-scripts start",
     "build": "react-scripts build",
     "test": "react-scripts test --env=jsdom",
```

574
>Note: To use a different preprocessor, replace `build-css` and `watch-css` commands according to your preprocessor’s documentation.
575
576
577

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
578
579
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.

580
581
582
583
584
585
586
587
588
589
590
591
592
593
To enable importing files without using relative paths, you can add the  `--include-path` option to the command in `package.json`.

```
"build-css": "node-sass-chokidar --include-path ./src --include-path ./node_modules src/ -o src/",
"watch-css": "npm run build-css && node-sass-chokidar --include-path ./src --include-path ./node_modules src/ -o src/ --watch --recursive",
```

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

594
595
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.

596
597
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:

598
599
```sh
npm install --save npm-run-all
600
```
601
602
603
604
605

Alternatively you may use `yarn`:

```sh
yarn add npm-run-all
606
607
608
```

Then we can change `start` and `build` scripts to include the CSS preprocessor commands:
609
610
611

```diff
   "scripts": {
Kelly's avatar
Kelly committed
612
613
     "build-css": "node-sass-chokidar src/ -o src/",
     "watch-css": "npm run build-css && node-sass-chokidar src/ -o src/ --watch --recursive",
614
615
-    "start": "react-scripts start",
-    "build": "react-scripts build",
616
617
+    "start-js": "react-scripts start",
+    "start": "npm-run-all -p watch-css start-js",
618
619
+    "build-js": "react-scripts build",
+    "build": "npm-run-all build-css build-js",
620
621
622
623
624
     "test": "react-scripts test --env=jsdom",
     "eject": "react-scripts eject"
   }
```

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

Kelly's avatar
Kelly committed
627
**Why `node-sass-chokidar`?**
628

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

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

Kelly's avatar
Kelly committed
633
- Infinite styles compiling [#1939](https://github.com/facebookincubator/create-react-app/issues/1939)
634

Kelly's avatar
Kelly committed
635
636
637
- `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.
638

639
## Adding Images, Fonts, and Files
Dan Abramov's avatar
Dan Abramov committed
640
641
642

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

643
644
645
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.

To reduce the number of requests to the server, importing images that are less than 10,000 bytes returns a [data URI](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs) instead of a path. This applies to the following file extensions: bmp, gif, jpg, jpeg, and png. SVG files are excluded due to [#1153](https://github.com/facebookincubator/create-react-app/issues/1153).
Dan Abramov's avatar
Dan Abramov committed
646
647
648
649
650
651
652

Here is an example:

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

653
console.log(logo); // /logo.84287d09.png
Dan Abramov's avatar
Dan Abramov committed
654
655
656
657
658
659

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

660
export default Header;
Dan Abramov's avatar
Dan Abramov committed
661
662
```

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

Dan Abramov's avatar
Dan Abramov committed
665
This works in CSS too:
Dan Abramov's avatar
Dan Abramov committed
666
667
668
669
670
671
672

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

673
674
675
676
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
677
**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
678
679
680
681
682
683
An alternative way of handling static assets is described in the next section.

## Using the `public` Folder

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

684
685
686
687
688
689
690
691
692
### 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.

693
Note that we normally encourage you to `import` assets in JavaScript files instead.
694
For example, see the sections on [adding a stylesheet](#adding-a-stylesheet) and [adding images and fonts](#adding-images-fonts-and-files).
695
This mechanism provides a number of benefits:
Dan Abramov's avatar
Dan Abramov committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712

* 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
713
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
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731

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.

732
733
### When to Use the `public` Folder

734
Normally we recommend importing [stylesheets](#adding-a-stylesheet), [images, and fonts](#adding-images-fonts-and-files) from JavaScript.
735
736
737
738
739
740
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.
741

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

744
## Using Global Variables
745
746
747
748
749
750
751
752
753
754
755
756
757

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
758
## Adding Bootstrap
759

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

762
Install React Bootstrap and Bootstrap from npm. React Bootstrap does not include Bootstrap CSS so this needs to be installed as well:
763

764
765
```sh
npm install --save react-bootstrap bootstrap@3
766
```
767
768
769
770
771

Alternatively you may use `yarn`:

```sh
yarn add react-bootstrap bootstrap@3
772
773
```

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

Dan Abramov's avatar
Dan Abramov committed
776
```js
777
778
import 'bootstrap/dist/css/bootstrap.css';
import 'bootstrap/dist/css/bootstrap-theme.css';
779
780
// Put any other imports below so that CSS from your
// components takes precedence over default styles.
781
782
```

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

Dan Abramov's avatar
Dan Abramov committed
785
```js
786
import { Navbar, Jumbotron, Button } from 'react-bootstrap';
787
```
788

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

791
792
793
794
795
796
797
798
799
800
801
### 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
802
## Adding Flow
803

804
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.
805

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

808
To add Flow to a Create React App project, follow these steps:
809

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

815
Now you can run `npm run flow` (or `yarn flow`) to check the files for type errors.
816
817
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.
818

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

821
822
823
824
825
826
827
## 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
828
npm install --save react-router-dom
829
830
831
832
833
```

Alternatively you may use `yarn`:

```sh
Dan Abramov's avatar
Dan Abramov committed
834
yarn add react-router-dom
835
836
837
838
839
840
```

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
841
## Adding Custom Environment Variables
842

Dan Abramov's avatar
Dan Abramov committed
843
>Note: this feature is available with `react-scripts@0.2.3` and higher.
844
845
846

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
847
848
`REACT_APP_`.

849
850
**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.

851
>Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid accidentally [exposing a private key on the machine that could have the same name](https://github.com/facebookincubator/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running.
852
853

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

856
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.
857

858
859
860
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.

861
862
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>`:
863
864

```jsx
Dan Abramov's avatar
Dan Abramov committed
865
866
867
868
869
870
871
872
873
874
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>
  );
}
875
876
```

877
878
879
880
881
882
883
884
885
886
887
888
889
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>
```

890
891
892
893
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.

894
895
896
897
898
899
900
901
Having access to the `NODE_ENV` is also useful for performing actions conditionally:

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

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

904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
### 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).

919
920
### Adding Temporary Environment Variables In Your Shell

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

Dan Abramov's avatar
Dan Abramov committed
924
#### Windows (cmd.exe)
925
926

```cmd
927
set "REACT_APP_SECRET_CODE=abcdef" && npm start
928
929
```

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

932
#### Linux, macOS (Bash)
933
934
935
936
937

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

938
### Adding Development Environment Variables In `.env`
939

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

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

```
REACT_APP_SECRET_CODE=abcdef
946
```
Mae Capozzi's avatar
Mae Capozzi committed
947
>Note: You must create custom environment variables beginning with `REACT_APP_`. Any other variables except `NODE_ENV` will be ignored to avoid [accidentally exposing a private key on the machine that could have the same name](https://github.com/facebookincubator/create-react-app/issues/865#issuecomment-252199527). Changing any environment variables will require you to restart the development server if it is running.
948

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

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

953
>Note: this feature is **available with `react-scripts@1.0.0` and higher**.
954

955
956
957
958
* `.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.
959

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

962
963
964
* `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)
965

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

969
970
>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).
971

Dan Abramov's avatar
Dan Abramov committed
972
973
## Can I Use Decorators?

Dan Abramov's avatar
Dan Abramov committed
974
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
975
976
977
978
979
980
Create React App doesn’t support decorator syntax at the moment because:

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

Dan Abramov's avatar
Dan Abramov committed
981
However in many cases you can rewrite decorator-based code without decorators just as fine.<br>
Dan Abramov's avatar
Dan Abramov committed
982
983
984
985
986
987
988
Please refer to these two threads for reference:

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

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

989
## Integrating with an API Backend
Dan Abramov's avatar
Dan Abramov committed
990

991
992
993
994
These tutorials will help you to integrate your app with an API backend running on another port,
using `fetch()` to access it.

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

### Ruby on Rails

1000
Check out [this tutorial](https://www.fullstackreact.com/articles/how-to-get-create-react-app-to-work-with-your-rails-api/).
For faster browsing, not all history is shown. View entire blame