├── src
    ├── index.ts
    ├── react-app-env.d.ts
    ├── use-previous.ts
    ├── use-search.test.ts
    └── use-search.ts
├── example
    ├── src
    │   ├── react-app-env.d.ts
    │   ├── index.tsx
    │   ├── App.tsx
    │   └── Search.tsx
    ├── public
    │   ├── manifest.json
    │   └── index.html
    ├── tsconfig.json
    ├── package.json
    └── README.md
├── .husky
    └── pre-commit
├── .npmignore
├── tsconfig.test.json
├── .gitignore
├── rollup.config.js
├── .github
    └── workflows
    │   └── test-and-build.yml
├── tsconfig.json
├── CHANGELOG.md
├── package.json
└── README.md


/src/index.ts:
--------------------------------------------------------------------------------
1 | export * from './use-search';
2 | 


--------------------------------------------------------------------------------
/src/react-app-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="react-scripts" />
2 | 


--------------------------------------------------------------------------------
/example/src/react-app-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="react-scripts" />
2 | 


--------------------------------------------------------------------------------
/.husky/pre-commit:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | . "$(dirname "$0")/_/husky.sh"
3 | 
4 | npm test
5 | 


--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | example/
2 | src/
3 | rollup.config.js
4 | tsconfig.json
5 | tsconfig.test.json
6 | yarn.lock
7 | 


--------------------------------------------------------------------------------
/tsconfig.test.json:
--------------------------------------------------------------------------------
1 | {
2 |   "extends": "./tsconfig.json",
3 |   "compilerOptions": {
4 |     "module": "commonjs"
5 |   }
6 | }
7 | 


--------------------------------------------------------------------------------
/example/src/index.tsx:
--------------------------------------------------------------------------------
1 | import * as React from "react";
2 | import * as ReactDOM from "react-dom";
3 | import App from "./App";
4 | 
5 | ReactDOM.render(<App />, document.getElementById("root"));
6 | 


--------------------------------------------------------------------------------
/example/public/manifest.json:
--------------------------------------------------------------------------------
1 | {
2 |   "short_name": "use-search",
3 |   "name": "use-search",
4 |   "start_url": "./index.html",
5 |   "display": "standalone",
6 |   "theme_color": "#000000",
7 |   "background_color": "#ffffff"
8 | }
9 | 


--------------------------------------------------------------------------------
/src/use-previous.ts:
--------------------------------------------------------------------------------
 1 | import { useEffect, useRef } from "react";
 2 | 
 3 | const usePrevious = <T>(value: T): T | undefined => {
 4 |   const ref = useRef<T>();
 5 | 
 6 |   useEffect(() => {
 7 |     ref.current = value;
 8 |   }, [value]);
 9 | 
10 |   return ref.current;
11 | };
12 | 
13 | export default usePrevious;
14 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | 
 2 | # See https://help.github.com/ignore-files/ for more about ignoring files.
 3 | 
 4 | # dependencies
 5 | node_modules
 6 | 
 7 | # builds
 8 | build
 9 | dist
10 | .rpt2_cache
11 | 
12 | # misc
13 | coverage
14 | .DS_Store
15 | .env
16 | .env.local
17 | .env.development.local
18 | .env.test.local
19 | .env.production.local
20 | 
21 | npm-debug.log*
22 | yarn-debug.log*
23 | yarn-error.log*
24 | 


--------------------------------------------------------------------------------
/example/public/index.html:
--------------------------------------------------------------------------------
 1 | <!doctype html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="utf-8">
 5 |     <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
 6 |     <meta name="theme-color" content="#000000">
 7 | 
 8 |     <link rel="manifest" href="%PUBLIC_URL%/manifest.json">
 9 | 
10 |     <title>use-search</title>
11 |   </head>
12 | 
13 |   <body>
14 |     <noscript>
15 |       You need to enable JavaScript to run this app.
16 |     </noscript>
17 | 
18 |     <div id="root"></div>
19 |   </body>
20 | </html>
21 | 


--------------------------------------------------------------------------------
/example/src/App.tsx:
--------------------------------------------------------------------------------
 1 | import * as React from "react";
 2 | import Search from "./Search";
 3 | 
 4 | const App = () => {
 5 |   const [isLoading, setIsLoading] = React.useState(true);
 6 |   const [users, setUsers] = React.useState([]);
 7 | 
 8 |   React.useEffect(() => {
 9 |     fetch("https://jsonplaceholder.typicode.com/users")
10 |       .then(response => response.json())
11 |       .then(users => {
12 |         setUsers(users);
13 |         setIsLoading(false);
14 |       });
15 |   }, []);
16 | 
17 |   return (
18 |     <div>{isLoading ? <p>Loading users ...</p> : <Search users={users} />}</div>
19 |   );
20 | };
21 | 
22 | export default App;
23 | 


--------------------------------------------------------------------------------
/example/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "target": "es5",
 4 |     "lib": [
 5 |       "dom",
 6 |       "dom.iterable",
 7 |       "esnext"
 8 |     ],
 9 |     "allowJs": true,
10 |     "skipLibCheck": true,
11 |     "esModuleInterop": true,
12 |     "allowSyntheticDefaultImports": true,
13 |     "strict": true,
14 |     "forceConsistentCasingInFileNames": true,
15 |     "module": "esnext",
16 |     "moduleResolution": "node",
17 |     "resolveJsonModule": true,
18 |     "isolatedModules": true,
19 |     "noEmit": true,
20 |     "jsx": "react-jsx",
21 |     "noFallthroughCasesInSwitch": true
22 |   },
23 |   "include": [
24 |     "src"
25 |   ]
26 | }
27 | 


--------------------------------------------------------------------------------
/example/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "use-search-example",
 3 |   "homepage": "https://emilbaekdahl.github.io/use-search",
 4 |   "version": "0.0.0",
 5 |   "license": "MIT",
 6 |   "private": true,
 7 |   "dependencies": {
 8 |     "@types/react-dom": "^17.0.9",
 9 |     "react": "link:../node_modules/react",
10 |     "react-dom": "^17.0.2",
11 |     "react-scripts": "^4.0.3",
12 |     "react-use-search": "link:.."
13 |   },
14 |   "scripts": {
15 |     "start": "react-scripts start",
16 |     "build": "react-scripts build",
17 |     "test": "react-scripts test --env=jsdom",
18 |     "eject": "react-scripts eject"
19 |   },
20 |   "browserslist": [
21 |     ">0.2%",
22 |     "not dead",
23 |     "not ie <= 11",
24 |     "not op_mini all"
25 |   ]
26 | }
27 | 


--------------------------------------------------------------------------------
/rollup.config.js:
--------------------------------------------------------------------------------
 1 | import typescript from 'rollup-plugin-typescript2'
 2 | import commonjs from 'rollup-plugin-commonjs'
 3 | import external from 'rollup-plugin-peer-deps-external'
 4 | import resolve from 'rollup-plugin-node-resolve'
 5 | import url from 'rollup-plugin-url'
 6 | 
 7 | import pkg from './package.json'
 8 | 
 9 | export default {
10 |   input: 'src/index.ts',
11 |   output: [
12 |     {
13 |       file: pkg.main,
14 |       format: 'cjs',
15 |       exports: 'named',
16 |       sourcemap: true
17 |     },
18 |     {
19 |       file: pkg.module,
20 |       format: 'es',
21 |       exports: 'named',
22 |       sourcemap: true
23 |     }
24 |   ],
25 |   plugins: [
26 |     external(),
27 |     url({ exclude: ['**/*.svg'] }),
28 |     resolve(),
29 |     typescript({
30 |       rollupCommonJSResolveHack: true,
31 |       clean: true
32 |     }),
33 |     commonjs()
34 |   ]
35 | }
36 | 


--------------------------------------------------------------------------------
/.github/workflows/test-and-build.yml:
--------------------------------------------------------------------------------
 1 | name: Test and build
 2 | 
 3 | on:
 4 |   push:
 5 |     branches: [main]
 6 |   pull_request:
 7 |     branches: [main]
 8 | 
 9 | jobs:
10 |   test:
11 |     runs-on: ubuntu-latest
12 | 
13 |     strategy:
14 |       matrix:
15 |         node-version: [12.x, 14.x, 16.x]
16 | 
17 |     steps:
18 |     - uses: actions/checkout@v2
19 |     - uses: actions/setup-node@v1
20 |       with:
21 |         node-version: ${{ matrix.node-version }}
22 |     - uses: bahmutov/npm-install@v1
23 |     - run: yarn test
24 | 
25 |   build:
26 |     runs-on: ubuntu-latest
27 | 
28 |     strategy:
29 |       matrix:
30 |         node-version: [12.x, 14.x, 16.x]
31 | 
32 |     steps:
33 |     - uses: actions/checkout@v2
34 |     - uses: actions/setup-node@v1
35 |       with:
36 |         node-version: ${{ matrix.node-version }}
37 |     - uses: bahmutov/npm-install@v1
38 |     - run: yarn build
39 | 


--------------------------------------------------------------------------------
/example/src/Search.tsx:
--------------------------------------------------------------------------------
 1 | import * as React from "react";
 2 | import { useSearch } from "react-use-search";
 3 | 
 4 | interface User {
 5 |   id: number;
 6 |   name: string;
 7 | }
 8 | 
 9 | interface Props {
10 |   users: Array<User>;
11 | }
12 | 
13 | const predicate = (user: User, query: string): boolean =>
14 |   user.name.toLowerCase().includes(query.toLowerCase());
15 | 
16 | const Search = ({ users }: Props) => {
17 |   const [filteredUsers, query, handleChange] = useSearch(users, predicate, {
18 |     filter: true,
19 |     debounce: 200,
20 |   });
21 | 
22 |   return (
23 |     <div>
24 |       <input
25 |         autoFocus
26 |         type="text"
27 |         value={query}
28 |         onChange={handleChange}
29 |         placeholder="Search ..."
30 |       />
31 | 
32 |       {filteredUsers.map((user) => (
33 |         <div key={user.id}>{user.name}</div>
34 |       ))}
35 |     </div>
36 |   );
37 | };
38 | 
39 | export default Search;
40 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "outDir": "build",
 4 |     "module": "esnext",
 5 |     "target": "es5",
 6 |     "lib": [
 7 |       "es6",
 8 |       "dom",
 9 |       "es2016",
10 |       "es2017"
11 |     ],
12 |     "sourceMap": true,
13 |     "allowJs": false,
14 |     "jsx": "react-jsx",
15 |     "declaration": true,
16 |     "moduleResolution": "node",
17 |     "forceConsistentCasingInFileNames": true,
18 |     "noImplicitReturns": true,
19 |     "noImplicitThis": true,
20 |     "noImplicitAny": true,
21 |     "strictNullChecks": true,
22 |     "suppressImplicitAnyIndexErrors": true,
23 |     "noUnusedLocals": true,
24 |     "noUnusedParameters": true,
25 |     "skipLibCheck": true,
26 |     "esModuleInterop": true,
27 |     "allowSyntheticDefaultImports": true,
28 |     "strict": true,
29 |     "resolveJsonModule": true,
30 |     "isolatedModules": true,
31 |     "noEmit": true,
32 |     "noFallthroughCasesInSwitch": true
33 |   },
34 |   "include": [
35 |     "src"
36 |   ],
37 |   "exclude": [
38 |     "node_modules",
39 |     "build",
40 |     "dist",
41 |     "example",
42 |     "rollup.config.js"
43 |   ]
44 | }
45 | 


--------------------------------------------------------------------------------
/src/use-search.test.ts:
--------------------------------------------------------------------------------
 1 | import { renderHook, act } from "@testing-library/react-hooks";
 2 | import { useSearch, Predicate } from "./use-search";
 3 | 
 4 | describe("useSearch", () => {
 5 |   const collection = ["test1@test.dk", "test2@test.dk"];
 6 |   const predicate: Predicate<string> = (item, query) => item.includes(query);
 7 | 
 8 |   it("returns the entire collection if filter is true", () => {
 9 |     const {
10 |       result: {
11 |         current: [filtered],
12 |       },
13 |     } = renderHook(() => useSearch(collection, predicate, { filter: true }));
14 | 
15 |     expect(filtered).toEqual(collection);
16 |   });
17 | 
18 |   it("returns empty collection if filter is not passed", () => {
19 |     const {
20 |       result: {
21 |         current: [filtered],
22 |       },
23 |     } = renderHook(() => useSearch(collection, predicate));
24 | 
25 |     expect(filtered).toEqual([]);
26 |   });
27 | 
28 |   it("returns filtered collection if initialQuery is passed", () => {
29 |     const {
30 |       result: {
31 |         current: [filtered],
32 |       },
33 |     } = renderHook(() =>
34 |       useSearch(collection, predicate, { initialQuery: "test2" })
35 |     );
36 | 
37 |     expect(filtered).toEqual(["test2@test.dk"]);
38 |   });
39 | 
40 |   it("sets query based on handleChange", () => {
41 |     const hook = renderHook(() => useSearch(collection, predicate));
42 | 
43 |     const value = "test";
44 | 
45 |     act(() => hook.result.current[2]({ target: { value } }));
46 | 
47 |     expect(hook.result.current[1]).toEqual(value);
48 |   });
49 | 
50 |   it("debounce", () => {
51 |     const { result } = renderHook(() =>
52 |       useSearch(collection, predicate, { debounce: 1000 })
53 |     );
54 | 
55 |     act(() => result.current[2]({ target: { value: "test" } }));
56 | 
57 |     expect(result.current[0]).toEqual([]);
58 |   });
59 | 
60 |   it("sets the query programmatically", () => {
61 |     const { result } = renderHook(() => useSearch(collection, predicate));
62 | 
63 |     act(() => result.current[3]("query"));
64 | 
65 |     expect(result.current[1]).toEqual("query");
66 |   });
67 | });
68 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # Changelog
 2 | 
 3 | All notable changes to this project will be documented in this file.
 4 | 
 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 7 | 
 8 | ## [Unreleased]
 9 | 
10 | ## [0.3.2] - 2021-12-08
11 | 
12 | ### Added
13 | 
14 |  - Lodash's `isEqual` is now used for comparing updates to `useSearch` parameters.
15 | 
16 | ## [0.3.1] - 2021-08-16
17 | 
18 | ### Added
19 | 
20 |  - We now interally monitor if the component that uses `useSearch` is mounted or not.
21 | 
22 | ## [0.3.0] - 2021-08-12
23 | 
24 | ### Added
25 | 
26 |  - `useSearch` now returns a `setQuery` function for programmatically updating the query string.
27 | 
28 | ## [0.2.8] - 2021-08-11
29 | 
30 | ### Added
31 | 
32 |  - Basically the same as below.
33 | 
34 | ## [0.2.7] - 2021-08-11
35 | 
36 | ### Added
37 | 
38 |  - The event handler type introduced in v0.2.6 is now actually reflected in the return type of `useSearch`.
39 | 
40 | ## [0.2.6] - 2021-08-11
41 | 
42 | ### Added
43 | 
44 |  - The input event handler return by `useSearch` is now typed to handle the `onChangeText` event (`(text: string) => void`) in React Native.
45 | 
46 | ## [0.2.5] - 2020-08-17
47 | 
48 | ### Added
49 | 
50 |  - Published package now includes `.es.js` and `.d.ts` files.
51 | 
52 | ## [0.2.4] - 2020-08-17
53 | 
54 | ### Changed
55 | 
56 | - All development dependencies updated.
57 | 
58 | ## [0.2.3] - 2019-09-03
59 | 
60 | ### Removed
61 | 
62 | - `console.log` statement in internal effect in `useSearch`.
63 | 
64 | ## [0.2.2] - 2019-08-29
65 | 
66 | ### Added
67 | 
68 | - A `debounce` (`number`) value can now be passed to the `useSearch` options.
69 | 
70 | ## [0.2.1] - 2019-08-27
71 | 
72 | ### Added
73 | 
74 | - `Predicate<T>` and `Options` types are now exported.
75 | 
76 | ### Changed
77 | 
78 | - _Internal_: The actual collection filtering has been abstracted out into an internal helper function.
79 | 
80 | ## [0.2.0] - 2019-08-20
81 | 
82 | ### Added
83 | 
84 | - `useSearch` React hook for filtering collections of objects based on user input.
85 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "react-use-search",
 3 |   "version": "0.3.2",
 4 |   "description": "React hook for searching and filtering data",
 5 |   "author": "emilbaekdahl",
 6 |   "keywords": [
 7 |     "react",
 8 |     "search",
 9 |     "filter",
10 |     "hook",
11 |     "typescript"
12 |   ],
13 |   "license": "MIT",
14 |   "repository": "prograsdk/react-use-search",
15 |   "main": "dist/index.js",
16 |   "module": "dist/index.es.js",
17 |   "jsnext:main": "dist/index.es.js",
18 |   "engines": {
19 |     "node": ">=8",
20 |     "npm": ">=5"
21 |   },
22 |   "scripts": {
23 |     "test": "cross-env CI=1 react-scripts test --env=jsdom",
24 |     "test:watch": "react-scripts test --env=jsdom",
25 |     "build": "rollup -c",
26 |     "start": "rollup -c -w",
27 |     "prepare": "yarn run build && husky install",
28 |     "predeploy": "cd example && yarn install && yarn run build",
29 |     "deploy": "gh-pages -d example/build"
30 |   },
31 |   "dependencies": {
32 |     "lodash.debounce": "^4.0.8",
33 |     "lodash.isequal": "^4.5.0"
34 |   },
35 |   "peerDependencies": {
36 |     "react": "^16.8.6"
37 |   },
38 |   "devDependencies": {
39 |     "@babel/core": "^7.15.0",
40 |     "@babel/runtime": "^7.14.8",
41 |     "@testing-library/react-hooks": "^7.0.1",
42 |     "@types/jest": "^26.0.24",
43 |     "@types/lodash.debounce": "^4.0.6",
44 |     "@types/lodash.isequal": "^4.5.5",
45 |     "@types/react": "^17.0.15",
46 |     "cross-env": "^7.0.3",
47 |     "gh-pages": "^3.2.3",
48 |     "husky": "^7.0.0",
49 |     "lint-staged": ">=11.1.1",
50 |     "prettier": "^2.3.2",
51 |     "react": "^17.0.2",
52 |     "react-scripts": "^4.0.3",
53 |     "react-test-renderer": "^17.0.2",
54 |     "rollup": "^2.56.0",
55 |     "rollup-plugin-babel": "^4.4.0",
56 |     "rollup-plugin-commonjs": "^10.1.0",
57 |     "rollup-plugin-node-resolve": "^5.2.0",
58 |     "rollup-plugin-peer-deps-external": "^2.2.4",
59 |     "rollup-plugin-typescript2": "^0.30.0",
60 |     "rollup-plugin-url": "^3.0.1",
61 |     "typescript": "^4.3.5"
62 |   },
63 |   "lint-staged": {
64 |     "*.{js,css,json,md}": [
65 |       "prettier --write",
66 |       "git add"
67 |     ]
68 |   }
69 | }
70 | 


--------------------------------------------------------------------------------
/src/use-search.ts:
--------------------------------------------------------------------------------
 1 | import * as React from "react";
 2 | import lodashDebounce from "lodash.debounce";
 3 | import lodashIsEqual from "lodash.isequal";
 4 | import usePrevious from "./use-previous";
 5 | 
 6 | export type Predicate<T> = (item: T, query: string) => boolean;
 7 | 
 8 | export interface Options {
 9 |   initialQuery?: string;
10 |   filter?: boolean;
11 |   debounce?: number;
12 | }
13 | 
14 | function filterCollection<T>(
15 |   collection: T[],
16 |   predicate: Predicate<T>,
17 |   query: string,
18 |   filter: boolean
19 | ): T[] {
20 |   if (query) {
21 |     return collection.filter((item) => predicate(item, query));
22 |   } else {
23 |     return filter ? collection : [];
24 |   }
25 | }
26 | 
27 | export function useSearch<T>(
28 |   collection: T[],
29 |   predicate: Predicate<T>,
30 |   { debounce, filter = false, initialQuery = "" }: Options = {}
31 | ): [
32 |   T[],
33 |   string,
34 |   (event: React.ChangeEvent<HTMLInputElement> | string) => void,
35 |   (querty: string) => void
36 | ] {
37 |   const isMounted = React.useRef<boolean>(false);
38 |   const [query, setQuery] = React.useState<string>(initialQuery);
39 |   const prevCollection = usePrevious(collection);
40 |   const prevPredicate = usePrevious(predicate);
41 |   const prevQuery = usePrevious(query);
42 |   const prevFilter = usePrevious(filter);
43 |   const [filteredCollection, setFilteredCollection] = React.useState<T[]>(() =>
44 |     filterCollection<T>(collection, predicate, query, filter)
45 |   );
46 | 
47 |   const handleChange = React.useCallback(
48 |     (event: React.ChangeEvent<HTMLInputElement> | string) => {
49 |       setQuery(typeof event === "string" ? event : event.target.value);
50 |     },
51 |     [setQuery]
52 |   );
53 | 
54 |   const debouncedFilterCollection = React.useCallback(
55 |     lodashDebounce(
56 |       (
57 |         collection: T[],
58 |         predicate: Predicate<T>,
59 |         query: string,
60 |         filter: boolean
61 |       ) => {
62 |         if (isMounted.current) {
63 |           setFilteredCollection(
64 |             filterCollection(collection, predicate, query, filter)
65 |           );
66 |         }
67 |       },
68 |       debounce
69 |     ),
70 |     [debounce]
71 |   );
72 | 
73 |   React.useEffect(() => {
74 |     if (
75 |       !lodashIsEqual(collection, prevCollection) ||
76 |       !lodashIsEqual(predicate, prevPredicate) ||
77 |       !lodashIsEqual(query, prevQuery) ||
78 |       !lodashIsEqual(filter, prevFilter)
79 |     )
80 |       debouncedFilterCollection(collection, predicate, query, filter);
81 |   }, [collection, predicate, query, filter]);
82 | 
83 |   React.useEffect(() => {
84 |     isMounted.current = true;
85 | 
86 |     return () => {
87 |       isMounted.current = false;
88 |     };
89 |   }, []);
90 | 
91 |   return [filteredCollection, query, handleChange, setQuery];
92 | }
93 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # react-use-search
  2 | 
  3 | > 🔍 React hook for searching and filtering data
  4 | 
  5 | [![NPM](https://img.shields.io/npm/v/react-use-search.svg)](https://www.npmjs.com/package/react-use-search)
  6 | [![CircleCI](https://circleci.com/gh/prograsdk/react-use-search.svg?style=svg)](https://circleci.com/gh/prograsdk/react-use-search)
  7 | [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
  8 | 
  9 | This React hook aims to provide a simple way to implement search/filter functionality in React components.
 10 | 
 11 | ## Install
 12 | 
 13 | ```bash
 14 | yarn add react-use-search
 15 | ```
 16 | 
 17 | ## Usage
 18 | 
 19 | #### `useSearch<T>`
 20 | 
 21 | `react-use-search` provides the `useSearch` hook as named export; it takes three parameters:
 22 | 
 23 |  * `collection: T[]`
 24 |  An array of elements of type `T`.
 25 |  
 26 |  * `predicate:`[`Predicate<T>`](#predicatet):
 27 |  A boolean predicate function used for filtering elements in `collection` based on a query.
 28 |  
 29 |  * `options:`[`Options`](#options): 
 30 |  configuration object.
 31 | 
 32 | The hook returns a 4-tuple of type `[T[], string, React.ChangeEventHandler<HTMLInputElement>, (query: string) => void]` consisting of the following elements:
 33 | 
 34 |  * `T[]`:
 35 |  A filtered version of `collection` passed to `useSearch`.
 36 |  
 37 |  * `string`:
 38 |  The current query.
 39 |  
 40 |  * `React.ChangeEventHandler<HTMLInputElement>`:
 41 |  An event handler for an HTML input element.
 42 |  This is to be passes to the search input element as its `onChange` prop.
 43 |  
 44 |  * `(query: text) => void`:
 45 |  A function to programmatically set the query value
 46 | 
 47 | The example show a simple component listing users that can be searched by email.
 48 | 
 49 | ```JSX
 50 | import React from 'react'
 51 | import {useSearch} from 'react-use-search'
 52 | import User from './User'
 53 | 
 54 | const predicate = (user, query) => user.email.includes(query)
 55 | 
 56 | const UserList = ({users}) => {
 57 |   const [filteredUsers, query, handleChange, setQuery] = useSearch(users, predicate, {debounce: 200})
 58 | 
 59 |   return (
 60 |     <div>
 61 |       <input placeholder="Search users by email..." value={query} onChange={handleChange} />
 62 |       {filteredUsers.map(user => <User key={user.id} {...user} />)}
 63 |       <button onClick={() => setQuery('@example')}>Search for @example addresses</button>
 64 |     </div>
 65 |   )
 66 | }
 67 | ```
 68 | 
 69 | ### Types
 70 | 
 71 | `react-use-search` exports the following types used to describe the parameteres of `useSearch`.
 72 | 
 73 | #### `Predicate<T>`
 74 | 
 75 | A binary boolean predicate function of type `(item: T, query: string) => boolean` used in `useSearch` to determine which elements of `collection` should be returned based on the current query.
 76 | The parameters of the function are:
 77 | 
 78 |  * `item: T`:
 79 |  The current element being evaluated.
 80 |  
 81 |  * `query: string`:
 82 |  The current query string.
 83 | 
 84 | ```typescript
 85 | import {Predicate} from 'react-use-search'
 86 | 
 87 | interface User {
 88 |   email: string;
 89 | }
 90 | 
 91 | const predicate: Predicate<User> = (user, query) => user.email.includes(query)
 92 | ```
 93 | 
 94 | #### `Options`
 95 | 
 96 | An options object used to configure `useSearch`.
 97 | It has the following properties:
 98 | 
 99 |  * `initialQuery?: string`: 
100 |  The query used for the initial collection returned from `useSearch`.
101 |  
102 |  * `filter?: boolean`: 
103 |  Determines if `useSearch` should behave in a _filtering_ or _searching_ like manner (according to [this definition on StackExchange](https://ux.stackexchange.com/a/4756)).
104 |  If `true`, all elements in `collection` are returned if the current query is empty;
105 |  if `false` (default), an empty array is returned.
106 |  
107 |  * `debounce?: number`:
108 |  This option allows the internal filtering functionality of `useSearch` to be debounced.
109 |  This can be advantageous in cases where `predicate` is complex or `collection` is large.
110 | 
111 | ## License
112 | 
113 | MIT © [Progras ApS](https://github.com/prograsdk)
114 | 
115 | ---
116 | 
117 | This hook is created using [create-react-hook](https://github.com/hermanya/create-react-hook).
118 | 


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


--------------------------------------------------------------------------------