├── src
    ├── .eslintrc
    ├── setupTests.js
    ├── styles.css
    ├── test.js
    ├── components
    │   ├── Tooltip.js
    │   ├── Legend.test.js
    │   ├── Legend.js
    │   ├── Domain.js
    │   ├── Lollipop.js
    │   └── SVGAxis.js
    └── index.js
├── example
    ├── src
    │   ├── index.css
    │   ├── index.js
    │   ├── mock
    │   │   ├── domains.json.js
    │   │   └── lollipops.json.js
    │   └── App.js
    ├── public
    │   ├── manifest.json
    │   └── index.html
    ├── package.json
    └── README.md
├── .travis.yml
├── .babelrc
├── .editorconfig
├── .gitignore
├── .eslintrc
├── rollup.config.js
├── README.md
├── package.json
└── LICENSE


/src/.eslintrc:
--------------------------------------------------------------------------------
1 | {
2 |   "env": {
3 |     "jest": true
4 |   }
5 | }
6 | 


--------------------------------------------------------------------------------
/example/src/index.css:
--------------------------------------------------------------------------------
1 | body {
2 |   margin: 0;
3 |   padding: 0;
4 |   font-family: sans-serif;
5 | }
6 | 


--------------------------------------------------------------------------------
/src/setupTests.js:
--------------------------------------------------------------------------------
1 | import { configure } from 'enzyme'
2 | import Adapter from 'enzyme-adapter-react-16'
3 | 
4 | configure({ adapter: new Adapter() })
5 | 


--------------------------------------------------------------------------------
/src/styles.css:
--------------------------------------------------------------------------------
1 | /* add css styles here (optional) */
2 | 
3 | .test {
4 |   display: inline-block;
5 |   margin: 2em auto;
6 |   border: 2px solid #000;
7 |   font-size: 2em;
8 | }
9 | 


--------------------------------------------------------------------------------
/src/test.js:
--------------------------------------------------------------------------------
1 | import ExampleComponent from './'
2 | 
3 | describe('ExampleComponent', () => {
4 |   it('is truthy', () => {
5 |     expect(ExampleComponent).toBeTruthy()
6 |   })
7 | })
8 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: node_js
 2 | node_js:
 3 |   - 14
 4 |   - 12
 5 |   - 11
 6 |   - 10
 7 | 
 8 | install:
 9 |   - yarn
10 |   - yarn build
11 | 
12 | script:
13 |   - yarn coverage
14 | 


--------------------------------------------------------------------------------
/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 |   "presets": [
3 |     ["@babel/preset-env", {
4 |       "modules": false
5 |     }],
6 |     "@babel/preset-react"
7 |   ],
8 |   "plugins": ["@babel/plugin-proposal-class-properties"]
9 | }


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | indent_style = space
 6 | indent_size = 2
 7 | end_of_line = lf
 8 | insert_final_newline = true
 9 | trim_trailing_whitespace = true
10 | 


--------------------------------------------------------------------------------
/example/src/index.js:
--------------------------------------------------------------------------------
1 | import React from 'react'
2 | import ReactDOM from 'react-dom'
3 | 
4 | import './index.css'
5 | import App from './App'
6 | 
7 | ReactDOM.render(<App />, document.getElementById('root'))
8 | 


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


--------------------------------------------------------------------------------
/.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 | .DS_Store
14 | .env
15 | .env.local
16 | .env.development.local
17 | .env.test.local
18 | .env.production.local
19 | 
20 | npm-debug.log*
21 | yarn-debug.log*
22 | yarn-error.log*
23 | 
24 | # idea
25 | .idea
26 | 
27 | # testing
28 | /coverage
29 | 


--------------------------------------------------------------------------------
/.eslintrc:
--------------------------------------------------------------------------------
 1 | {
 2 |   "parser": "babel-eslint",
 3 |   "extends": [
 4 |     "standard",
 5 |     "standard-react"
 6 |   ],
 7 |   "env": {
 8 |     "es6": true
 9 |   },
10 |   "plugins": [
11 |     "react"
12 |   ],
13 |   "parserOptions": {
14 |     "sourceType": "module"
15 |   },
16 |   "rules": {
17 |     // don't force es6 functions to include space before paren
18 |     "space-before-function-paren": 0,
19 | 
20 |     // allow specifying true explicitly for boolean props
21 |     "react/jsx-boolean-value": 0
22 |   }
23 | }
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>react-mutation-plot</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/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "react-mutation-plot-example",
 3 |   "homepage": "https://.github.io/react-mutation-plot",
 4 |   "version": "0.0.0",
 5 |   "license": "MIT",
 6 |   "private": true,
 7 |   "dependencies": {
 8 |     "prop-types": "^15.7.2",
 9 |     "react": "^16.8.6",
10 |     "react-dom": "^16.8.6",
11 |     "react-scripts": "^1.1.4",
12 |     "react-mutation-plot": "link:.."
13 |   },
14 |   "scripts": {
15 |     "start": "PORT=3008 react-scripts start",
16 |     "build": "react-scripts build",
17 |     "test": "react-scripts test --env=jsdom",
18 |     "eject": "react-scripts eject"
19 |   }
20 | }
21 | 


--------------------------------------------------------------------------------
/src/components/Tooltip.js:
--------------------------------------------------------------------------------
 1 | import * as React from 'react'
 2 | import ReactTooltip from 'react-tooltip'
 3 | import PropTypes from 'prop-types'
 4 | 
 5 | export const getTooltipContent = (tooltip) => {
 6 |   const header = (tooltip || {}).header ? `<div>${tooltip.header}</div>` : ''
 7 |   const body = (tooltip || {}).body ? `<div>${tooltip.body}</div>` : ''
 8 |   return (`<div>${header}${body}</div>`)
 9 | }
10 | 
11 | class Tooltip extends React.Component {
12 |   componentDidUpdate() {
13 |     ReactTooltip.rebuild()
14 |   }
15 | 
16 |   getContentHandler = (dataTip) => {
17 |     if (!dataTip) return ''
18 |     return (dataTip)
19 |   }
20 | 
21 |   render() {
22 |     return (<ReactTooltip
23 |       id={this.props.id}
24 |       html={true}
25 |       getContent={this.getContentHandler}
26 |     />)
27 |   }
28 | }
29 | 
30 | Tooltip.propTypes = {
31 |   id: PropTypes.string
32 | }
33 | 
34 | export default Tooltip
35 | 


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


--------------------------------------------------------------------------------
/src/components/Legend.test.js:
--------------------------------------------------------------------------------
 1 | import React from 'react'
 2 | import {shallow} from 'enzyme'
 3 | import Legend from './Legend'
 4 | 
 5 | export const mockDomains = [
 6 |   {
 7 |     'startCodon': 57,
 8 |     'endCodon': 167,
 9 |     'label': 'Recep_L_domain',
10 |     'color': '#2dcf00',
11 |     'tooltip': {
12 |       'header': 'Recep_L_domain',
13 |       'body': 'Recep_L_domain (57 - 167)'
14 |     }
15 |   },
16 |   {
17 |     'startCodon': 185,
18 |     'endCodon': 338,
19 |     'label': 'Furin-like',
20 |     'color': '#ff5353',
21 |     'tooltip': {
22 |       'header': 'Furin-like'
23 |     }
24 |   }
25 | ]
26 | 
27 | describe('Legend', () => {
28 |   it('should not render anything if theres is no domains', () => {
29 |     const wrapper = shallow(<Legend domains={[]} />)
30 |     expect(wrapper).toEqual({})
31 |   })
32 |   it('should render legend', () => {
33 |     const wrapper = shallow(<Legend domains={mockDomains} />)
34 |     expect(wrapper.find('g').length).toBe(1)
35 |     expect(wrapper.find('rect').length).toBe(2)
36 |   })
37 | })
38 | 


--------------------------------------------------------------------------------
/example/src/mock/domains.json.js:
--------------------------------------------------------------------------------
 1 | export const domains = [
 2 |   {
 3 |     'startCodon': 57,
 4 |     'endCodon': 167,
 5 |     'label': 'Recep_L_domain',
 6 |     'color': '#2dcf00',
 7 |     'tooltip': {
 8 |       'header': 'Recep_L_domain',
 9 |       'body': 'Recep_L_domain (57 - 167)'
10 |     }
11 |   },
12 |   {
13 |     'startCodon': 185,
14 |     'endCodon': 338,
15 |     'label': 'Furin-like',
16 |     'color': '#ff5353',
17 |     'tooltip': {
18 |       'header': 'Furin-like'
19 |     }
20 |   },
21 |   {
22 |     'startCodon': 361,
23 |     'endCodon': 480,
24 |     'label': 'Recep_L_domain',
25 |     'color': '#2dcf00'
26 |   },
27 |   {
28 |     'startCodon': 505,
29 |     'endCodon': 636,
30 |     'label': 'GF_recep_IV',
31 |     'color': '#5b5bff',
32 |     'tooltip': {
33 |       'header': 'Title',
34 |       'body': 'Description'
35 |     }
36 |   },
37 |   {
38 |     'startCodon': 713,
39 |     'endCodon': 965,
40 |     'label': 'Pkinase_Tyr',
41 |     'color': '#ebd61d',
42 |     'tooltip': {
43 |       'header': 'Title',
44 |       'body': 'Description'
45 |     }
46 |   }
47 | ]
48 | 


--------------------------------------------------------------------------------
/example/src/App.js:
--------------------------------------------------------------------------------
 1 | import React, {Component} from 'react'
 2 | 
 3 | import LollipopPlot from 'react-mutation-plot'
 4 | import {lollipops} from './mock/lollipops.json'
 5 | import {domains} from './mock/domains.json'
 6 | 
 7 | const mockData = {
 8 |   vizHeight: 130, // hardcoded
 9 |   vizWidth: 665, // hardcoded
10 |   xMax: 1210, // protein length
11 |   yMax: 23, // max #mutations
12 |   hugoGeneSymbol: 'EGFR',
13 |   lollipops: lollipops,
14 |   domains: domains
15 | }
16 | 
17 | const options = {
18 |   displayDomainLabel: false,
19 |   displayLegend: true,
20 |   exportToPDF: true
21 | }
22 | 
23 | const onLollipopClickHandler = (data) => {
24 |   console.log('onLollipopClick', data)
25 | }
26 | 
27 | export default class App extends Component {
28 |   render() {
29 |     return (
30 |       <LollipopPlot
31 |         domains={mockData.domains}
32 |         lollipops={mockData.lollipops}
33 |         vizWidth={mockData.vizWidth}
34 |         vizHeight={mockData.vizHeight}
35 |         hugoGeneSymbol={mockData.hugoGeneSymbol}
36 |         xMax={mockData.xMax}
37 |         yMax={mockData.yMax}
38 |         onLollipopClick={onLollipopClickHandler}
39 |         options={options}
40 |       />
41 |     )
42 |   }
43 | }
44 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # react-mutation-plot
 2 | 
 3 | > A light weight adaptation React based mutation lollipop plot from [cBioPortal frontend](https://github.com/cBioPortal/cbioportal-frontend).
 4 | 
 5 | [![NPM](https://img.shields.io/npm/v/react-mutation-plot.svg)](https://www.npmjs.com/package/react-mutation-plot)
 6 | [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 7 | [![build status](https://img.shields.io/travis/thehyve/react-mutation-plot/master.svg)](https://travis-ci.org/thehyve/react-mutation-plot)
 8 | 
 9 | ![schermafbeelding 2019-02-19 om 17 56 14](https://user-images.githubusercontent.com/2835281/53032819-e6d14780-346f-11e9-8623-1e9e5b39b0ea.png)
10 | 
11 | ## Install
12 | 
13 | ```bash
14 | npm install --save react-mutation-plot
15 | ```
16 | 
17 | ## Usage
18 | 
19 | Check the `/example` folder for a complete usage. 
20 | 
21 | ```jsx
22 | import React, { Component } from 'react'
23 | 
24 | import Lollipop from 'react-mutation-plot'
25 | 
26 | class Example extends Component {
27 |   render () {
28 |     return (
29 |       <LollipopPlot
30 |         domains={domains}
31 |         lollipops={lollipops}
32 |         vizWidth={vizWidth}
33 |         vizHeight={vizHeight}
34 |         hugoGeneSymbol={hugoGeneSymbol}
35 |         xMax={xMax}
36 |         yMax={yMax}
37 |         onLollipopClick={onLollipopClickHandler}
38 |       />
39 |     )
40 |   }
41 | }
42 | ```
43 | 


--------------------------------------------------------------------------------
/src/components/Legend.js:
--------------------------------------------------------------------------------
 1 | import * as PropTypes from 'prop-types'
 2 | import * as React from 'react'
 3 | 
 4 | const renderDomainLegendItems = (uniqueDomains) => {
 5 |   return uniqueDomains.map((d, idx) => {
 6 |     return (
 7 |       <React.Fragment key={`${d.label}_${idx}`}>
 8 |         <rect
 9 |           fill={d.color}
10 |           x={770}
11 |           y={32 + (15 * idx) + 'px'}
12 |           width={10}
13 |           height={10}
14 |         />
15 |         <text
16 |           x={785}
17 |           y={40 + (15 * idx) + 'px'}
18 |           style={{
19 |             fontSize: '11px',
20 |             fontFamily: 'arial'
21 |           }}
22 |         >
23 |           {d.label}
24 |         </text>
25 |       </React.Fragment>)
26 |   })
27 | }
28 | 
29 | const pfamDomainsLegend = (domains) => {
30 |   const uniqueDomains = Array.from(new Set(domains.map(d => d.label)))
31 |     .map(label => ({
32 |       label: label,
33 |       color: domains.find(d => d.label === label).color
34 |     }))
35 |   return uniqueDomains.length ? (
36 |     <g>
37 |       <text x='770'
38 |         y='20'
39 |         style={{
40 |           fontSize: '12px',
41 |           fontWeight: 'bold',
42 |           fontFamily: 'arial',
43 |           fill: '#333'
44 |         }}
45 |       >
46 |         Pfam domains:
47 |       </text>
48 |       {renderDomainLegendItems(uniqueDomains)}
49 |     </g>
50 |   ) : ''
51 | }
52 | 
53 | const legend = (props) => {
54 |   const {domains} = props
55 |   return domains ? pfamDomainsLegend(domains) : ''
56 | }
57 | 
58 | legend.propTypes = {
59 |   domains: PropTypes.array
60 | }
61 | export default legend
62 | 


--------------------------------------------------------------------------------
/example/src/mock/lollipops.json.js:
--------------------------------------------------------------------------------
  1 | export const lollipops = [
  2 |   {
  3 |     'codon': 858,
  4 |     'count': 23,
  5 |     'tooltip': {
  6 |       'header': 'Title',
  7 |       'body': 'Description'
  8 |     },
  9 |     'color': '#008000',
 10 |     'id': 'variant-id-001',
 11 |     'label': {
 12 |       'text': 'L858R',
 13 |       'textAnchor': 'middle',
 14 |       'fontSize': 10,
 15 |       'fontFamily': 'arial'
 16 |     },
 17 |     'selected': true
 18 |   },
 19 |   {
 20 |     'codon': 746,
 21 |     'count': 17,
 22 |     'tooltip': {
 23 |       'header': 'Title',
 24 |       'body': 'Description'
 25 |     },
 26 |     'color': '#993404',
 27 |     'selected': true
 28 |   },
 29 |   {
 30 |     'codon': 861,
 31 |     'count': 5,
 32 |     'tooltip': {
 33 |       'header': 'Title',
 34 |       'body': 'Description'
 35 |     },
 36 |     'color': '#008000'
 37 |   },
 38 |   {
 39 |     'codon': 747,
 40 |     'count': 5,
 41 |     'tooltip': {
 42 |       'header': 'Title',
 43 |       'body': 'Description'
 44 |     },
 45 |     'color': '#993404',
 46 |     'selected': false
 47 |   },
 48 |   {
 49 |     'codon': 768,
 50 |     'count': 3,
 51 |     'tooltip': {
 52 |       'header': 'Title',
 53 |       'body': 'Description'
 54 |     },
 55 |     'color': '#008000'
 56 |   },
 57 |   {
 58 |     'codon': 754,
 59 |     'count': 3,
 60 |     'tooltip': {
 61 |       'header': 'Title',
 62 |       'body': 'Description'
 63 |     },
 64 |     'color': '#008000'
 65 |   },
 66 |   {
 67 |     'codon': 719,
 68 |     'count': 3,
 69 |     'tooltip': {
 70 |       'header': 'Title',
 71 |       'body': 'Description'
 72 |     },
 73 |     'color': '#008000'
 74 |   },
 75 |   {
 76 |     'codon': 709,
 77 |     'count': 3,
 78 |     'tooltip': {
 79 |       'header': 'Title',
 80 |       'body': 'Description'
 81 |     },
 82 |     'color': '#993404'
 83 |   },
 84 |   {
 85 |     'codon': 833,
 86 |     'count': 2,
 87 |     'tooltip': {
 88 |       'header': 'Title',
 89 |       'body': 'Description'
 90 |     },
 91 |     'color': '#008000'
 92 |   },
 93 |   {
 94 |     'codon': 1,
 95 |     'count': 1,
 96 |     'tooltip': {
 97 |       'header': 'Title',
 98 |       'body': 'Description'
 99 |     },
100 |     'color': '#cf58bc'
101 |   }
102 | ]
103 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "react-mutation-plot",
 3 |   "version": "1.3.1",
 4 |   "description": "A light weight React based mutation lollipop plot.",
 5 |   "author": "Riza Nugraha",
 6 |   "license": "GPL-3.0-or-later",
 7 |   "repository": "/react-mutation-plot",
 8 |   "main": "dist/index.js",
 9 |   "module": "dist/index.es.js",
10 |   "jsnext:main": "dist/index.es.js",
11 |   "engines": {
12 |     "node": ">=10",
13 |     "npm": ">=5"
14 |   },
15 |   "scripts": {
16 |     "test": "cross-env CI=1 react-scripts test --env=jsdom",
17 |     "coverage": "cross-env CI=1 react-scripts test --env=jsdom --coverage",
18 |     "test:watch": "react-scripts test --env=jsdom",
19 |     "build": "rollup -c",
20 |     "start": "rollup -c -w",
21 |     "prepare": "yarn run build",
22 |     "predeploy": "cd example && yarn install && yarn run build",
23 |     "deploy": "gh-pages -d example/build"
24 |   },
25 |   "peerDependencies": {
26 |     "prop-types": "^15.7.2",
27 |     "react": "^16.8.6",
28 |     "react-dom": "^16.8.6"
29 |   },
30 |   "devDependencies": {
31 |     "@babel/core": "^7.0.0",
32 |     "@babel/plugin-external-helpers": "^7.0.0",
33 |     "@babel/plugin-proposal-class-properties": "^7.0.0",
34 |     "@babel/plugin-proposal-decorators": "^7.0.0",
35 |     "@babel/plugin-proposal-do-expressions": "^7.0.0",
36 |     "@babel/plugin-proposal-export-default-from": "^7.0.0",
37 |     "@babel/plugin-proposal-export-namespace-from": "^7.0.0",
38 |     "@babel/plugin-proposal-function-bind": "^7.0.0",
39 |     "@babel/plugin-proposal-function-sent": "^7.0.0",
40 |     "@babel/plugin-proposal-json-strings": "^7.0.0",
41 |     "@babel/plugin-proposal-logical-assignment-operators": "^7.0.0",
42 |     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.0.0",
43 |     "@babel/plugin-proposal-numeric-separator": "^7.0.0",
44 |     "@babel/plugin-proposal-optional-chaining": "^7.0.0",
45 |     "@babel/plugin-proposal-pipeline-operator": "^7.0.0",
46 |     "@babel/plugin-proposal-throw-expressions": "^7.0.0",
47 |     "@babel/plugin-syntax-dynamic-import": "^7.0.0",
48 |     "@babel/plugin-syntax-import-meta": "^7.0.0",
49 |     "@babel/preset-env": "^7.0.0",
50 |     "@babel/preset-react": "^7.0.0",
51 |     "@svgr/rollup": "^2.4.1",
52 |     "babel-eslint": "^10.0.1",
53 |     "cross-env": "^5.1.4",
54 |     "enzyme": "^3.8.0",
55 |     "enzyme-adapter-react-16": "^1.9.1",
56 |     "eslint": "^5.0.1",
57 |     "eslint-config-standard": "^11.0.0",
58 |     "eslint-config-standard-react": "^6.0.0",
59 |     "eslint-plugin-import": "^2.13.0",
60 |     "eslint-plugin-node": "^7.0.1",
61 |     "eslint-plugin-promise": "^4.0.0",
62 |     "eslint-plugin-react": "^7.10.0",
63 |     "eslint-plugin-standard": "^3.1.0",
64 |     "gh-pages": "^1.2.0",
65 |     "react": "^16.4.1",
66 |     "react-dom": "^16.4.1",
67 |     "react-scripts": "^1.1.4",
68 |     "rollup": "^0.64.1",
69 |     "rollup-plugin-babel": "^4.0.1",
70 |     "rollup-plugin-commonjs": "^9.1.3",
71 |     "rollup-plugin-node-resolve": "^3.3.0",
72 |     "rollup-plugin-peer-deps-external": "^2.2.0",
73 |     "rollup-plugin-postcss": "^1.6.2",
74 |     "rollup-plugin-url": "^1.4.0"
75 |   },
76 |   "files": [
77 |     "dist"
78 |   ],
79 |   "dependencies": {
80 |     "jspdf-yworks": "^2.0.1",
81 |     "prop-types": "^15.6.2",
82 |     "react-tooltip": "^3.9.2",
83 |     "save-svg-as-png": "^1.4.11",
84 |     "svg2pdf": "^1.0.0",
85 |     "svg2pdf.js": "^1.3.3"
86 |   }
87 | }
88 | 


--------------------------------------------------------------------------------
/src/components/Domain.js:
--------------------------------------------------------------------------------
  1 | import * as React from 'react'
  2 | import PropTypes from 'prop-types'
  3 | import {getTooltipContent} from './Tooltip'
  4 | 
  5 | export const domainSpec = PropTypes.shape({
  6 |   startCodon: PropTypes.number,
  7 |   endCodon: PropTypes.number,
  8 |   color: PropTypes.string,
  9 |   label: PropTypes.string,
 10 |   labelColor: PropTypes.string
 11 | })
 12 | 
 13 | class Domain extends React.Component {
 14 |   centerX = () => {
 15 |     return this.props.x + (this.props.width / 2)
 16 |   }
 17 | 
 18 |   centerY = () => {
 19 |     return this.props.y + (this.props.height / 2)
 20 |   }
 21 | 
 22 |   displayText = () => {
 23 |     const label = document.getElementById(this.props.id)
 24 |     let labelLength = label ? label.textLength.baseVal.value : 0
 25 |     let displayText = this.props.label
 26 |     if (labelLength) {
 27 |       let substringLength = labelLength
 28 |       // Find the number of characters that will fit inside
 29 |       while ((substringLength > 0) &&
 30 |       (label.getSubStringLength(0, substringLength) > this.props.width)) {
 31 |         substringLength -= 1
 32 |       }
 33 |       if (substringLength < labelLength) {
 34 |         // If we have to do shortening
 35 |         substringLength -= 2 // make room for ellipsis ..
 36 |         if (substringLength <= 0) {
 37 |           // too short to show any string
 38 |           displayText = ''
 39 |         } else {
 40 |           // if it's long enough to show anything at all
 41 |           displayText = displayText.substr(0, substringLength) + '..'
 42 |         }
 43 |       }
 44 |     }
 45 |     return displayText
 46 |   }
 47 | 
 48 |   makeTextElement = (reference) => {
 49 |     let props = {
 50 |       x: this.centerX(),
 51 |       y: this.centerY(),
 52 |       textAnchor: 'middle',
 53 |       dy: '0.3em',
 54 |       fill: (this.props.labelColor || '#FFFFFF'),
 55 |       style: {
 56 |         fontSize: '12px',
 57 |         fontFamily: 'arial'
 58 |       }
 59 |     }
 60 |     const text = (reference ? (this.props.label || '') : this.displayText())
 61 |     if (reference) {
 62 |       props.id = this.props.id
 63 |       props.visibility = 'hidden'
 64 |       props.style = {opacity: 0}
 65 |     }
 66 |     return (this.props.displayLabel ? <text {...props}>{text}</text> : '')
 67 |   }
 68 | 
 69 |   render() {
 70 |     return (
 71 |       <g>
 72 |         <rect
 73 |           x={this.props.x}
 74 |           y={this.props.y}
 75 |           width={this.props.width}
 76 |           height={this.props.height}
 77 |           fill={this.props.color}
 78 |         />
 79 |         {this.makeTextElement(true)}
 80 |         {this.makeTextElement(false)}
 81 |         <rect
 82 |           x={this.props.x}
 83 |           y={this.props.y}
 84 |           width={this.props.width}
 85 |           height={this.props.height}
 86 |           style={{opacity: 0}}
 87 |           data-tip={getTooltipContent(this.props.tooltip)}
 88 |           data-for='domainTooltip'
 89 |         />
 90 |       </g>
 91 |     )
 92 |   }
 93 | }
 94 | 
 95 | Domain.propTypes = {
 96 |   x: PropTypes.number,
 97 |   y: PropTypes.number,
 98 |   width: PropTypes.number,
 99 |   height: PropTypes.number,
100 |   color: PropTypes.string,
101 |   label: PropTypes.string,
102 |   labelColor: PropTypes.string,
103 |   spec: domainSpec,
104 |   tooltip: PropTypes.any,
105 |   id: PropTypes.string,
106 |   displayLabel: PropTypes.bool
107 | }
108 | 
109 | export default Domain
110 | 


--------------------------------------------------------------------------------
/src/components/Lollipop.js:
--------------------------------------------------------------------------------
  1 | import * as React from 'react'
  2 | import PropTypes from 'prop-types'
  3 | import {getTooltipContent} from './Tooltip'
  4 | 
  5 | export const lollipopSpec = PropTypes.shape({
  6 |   codon: PropTypes.number,
  7 |   count: PropTypes.number,
  8 |   tooltip: PropTypes.shape({
  9 |     header: PropTypes.string,
 10 |     body: PropTypes.string
 11 |   }),
 12 |   label: PropTypes.shape({
 13 |     text: PropTypes.string,
 14 |     textAnchor: PropTypes.string,
 15 |     fontSize: PropTypes.number,
 16 |     fontFamily: PropTypes.string
 17 |   }),
 18 |   id: PropTypes.string,
 19 |   selected: PropTypes.bool,
 20 |   color: PropTypes.string
 21 | })
 22 | 
 23 | class Lollipop extends React.Component {
 24 |   constructor(props) {
 25 |     super(props)
 26 |     this.state = {
 27 |       isSelected: props.selected
 28 |     }
 29 |   }
 30 | 
 31 |   headRadius = () => {
 32 |     return this.state.isSelected ? this.props.hoverHeadRadius : this.props.headRadius
 33 |   }
 34 | 
 35 |   circleX = () => {
 36 |     return this.props.x
 37 |   }
 38 | 
 39 |   circleY = () => {
 40 |     return this.props.stickBaseY - this.props.stickHeight
 41 |   }
 42 | 
 43 |   circleHitRect = () => {
 44 |     return {
 45 |       x: this.circleX() - this.props.hoverHeadRadius,
 46 |       y: this.circleY() - this.props.hoverHeadRadius,
 47 |       width: this.props.hoverHeadRadius * 2,
 48 |       height: this.props.hoverHeadRadius * 2
 49 |     }
 50 |   }
 51 | 
 52 |   onClickHandler = (e) => {
 53 |     if (this.props.onClick) {
 54 |       this.props.onClick(this.props)
 55 |     }
 56 |     this.setState({
 57 |       isSelected: !this.state.isSelected
 58 |     })
 59 |   }
 60 | 
 61 |   render() {
 62 |     let label = null
 63 |     if (this.props.label) {
 64 |       label = (
 65 |         <text
 66 |           fill='#2E3436'
 67 |           style={{
 68 |             fontSize: this.props.label.fontSize || 10,
 69 |             fontFamily: this.props.label.fontFamily || 'arial'
 70 |           }}
 71 |           textAnchor={this.props.label.textAnchor || 'middle'}
 72 |           x={this.props.x}
 73 |           y={this.props.stickBaseY - this.props.stickHeight - this.props.headRadius - 5}
 74 |         >
 75 |           {this.props.label.text}
 76 |         </text>
 77 |       )
 78 |     }
 79 |     return (
 80 |       <g>
 81 |         <line
 82 |           strokeWidth='1'
 83 |           stroke={this.props.stickColor || '#BABDB6'}
 84 |           x1={this.props.x}
 85 |           x2={this.props.x}
 86 |           y1={this.props.stickBaseY}
 87 |           y2={this.props.stickBaseY - this.props.stickHeight}
 88 |         />
 89 |         <circle
 90 |           stroke='#BABDB6'
 91 |           strokeWidth='0.5'
 92 |           fill={this.props.headColor || '#000000'}
 93 |           r={this.headRadius()}
 94 |           cx={this.circleX()}
 95 |           cy={this.circleY()}
 96 |           data-tip={getTooltipContent(this.props.tooltip)}
 97 |           data-for='lollipopTooltip'
 98 |           onClick={this.onClickHandler}
 99 |         />
100 |         {label}
101 |       </g>
102 |     )
103 |   }
104 | }
105 | 
106 | Lollipop.propTypes = {
107 |   x: PropTypes.number,
108 |   stickBaseY: PropTypes.number,
109 |   stickHeight: PropTypes.number,
110 |   headRadius: PropTypes.number,
111 |   hoverHeadRadius: PropTypes.number,
112 |   headColor: PropTypes.string,
113 |   stickColor: PropTypes.string,
114 |   label: PropTypes.shape({
115 |     text: PropTypes.string,
116 |     textAnchor: PropTypes.string,
117 |     fontSize: PropTypes.number,
118 |     fontFamily: PropTypes.string
119 |   }),
120 |   tooltip: PropTypes.any,
121 |   selected: PropTypes.bool,
122 |   id: PropTypes.string,
123 |   onClick: PropTypes.func
124 | }
125 | 
126 | export default Lollipop
127 | 


--------------------------------------------------------------------------------
/src/components/SVGAxis.js:
--------------------------------------------------------------------------------
  1 | import * as React from 'react'
  2 | import PropTypes from 'prop-types'
  3 | 
  4 | class SVGAxis extends React.Component {
  5 |   positionToAxisPosition = (position) => {
  6 |     return (position / (this.props.rangeUpper - this.props.rangeLower)) * this.props.length
  7 |   }
  8 | 
  9 |   ticks = () => {
 10 |     return this.props.ticks.map(tick => {
 11 |       const axisPosition = this.positionToAxisPosition(tick.position)
 12 |       const x1 = this.props.vertical ? this.props.x : (this.props.x + axisPosition)
 13 |       const y1 = this.props.vertical ? (this.props.y + this.props.length - axisPosition) : this.props.y
 14 |       const x2 = this.props.vertical ? (this.props.x - this.props.tickLength) : (this.props.x + axisPosition)
 15 |       const y2 = this.props.vertical ? (this.props.y + this.props.length - axisPosition) : (this.props.y + this.props.tickLength)
 16 |       const labelPadding = 3
 17 | 
 18 |       let label = null
 19 |       if (tick.label) {
 20 |         if (this.props.vertical) {
 21 |           label = (
 22 |             <text
 23 |               textAnchor='end'
 24 |               style={{
 25 |                 fontSize: '10px',
 26 |                 fontFamily: 'arial'
 27 |               }}
 28 |               dx={-1 * labelPadding}
 29 |               dy='0.4em'
 30 |               x={x2}
 31 |               y={y2}
 32 |             >
 33 |               {tick.label}
 34 |             </text>
 35 |           )
 36 |         } else {
 37 |           label = (
 38 |             <text
 39 |               textAnchor='middle'
 40 |               style={{
 41 |                 fontSize: '10px',
 42 |                 fontFamily: 'arial'
 43 |               }}
 44 |               x={x2}
 45 |               y={y2}
 46 |               dy='1em'
 47 |             >
 48 |               {tick.label}
 49 |             </text>
 50 |           )
 51 |         }
 52 |       }
 53 |       return (
 54 |         <g key={axisPosition}>
 55 |           <line
 56 |             stroke='rgb(170,170,170)'
 57 |             strokeWidth='1'
 58 |             x1={x1}
 59 |             y1={y1}
 60 |             x2={x2}
 61 |             y2={y2}
 62 |           />
 63 |           {label}
 64 |         </g>
 65 |       )
 66 |     })
 67 |   }
 68 | 
 69 |   label = () => {
 70 |     if (this.props.label) {
 71 |       let x
 72 |       let y
 73 |       let transform
 74 |       if (this.props.vertical) {
 75 |         x = this.props.x - this.props.tickLength - 30
 76 |         y = this.props.y + (this.props.length / 2)
 77 |         transform = `rotate(270,${x},${y})`
 78 |       } else {
 79 |         x = this.props.x + (this.props.length / 2)
 80 |         y = this.props.y + this.props.tickLength + 5
 81 |         transform = ''
 82 |       }
 83 |       return (
 84 |         <text
 85 |           textAnchor='middle'
 86 |           style={{
 87 |             fontFamily: 'arial',
 88 |             fontSize: '12px',
 89 |             fontWeight: 'normal'
 90 |           }}
 91 |           fill='#2E3436'
 92 |           x={x}
 93 |           y={y}
 94 |           transform={transform}
 95 |         >
 96 |           {this.props.label}
 97 |         </text>
 98 |       )
 99 |     } else {
100 |       return null
101 |     }
102 |   }
103 | 
104 |   render() {
105 |     const x2 = this.props.vertical ? this.props.x : (this.props.x + this.props.length)
106 |     const y2 = this.props.vertical ? (this.props.y + this.props.length) : this.props.y
107 |     return (
108 |       <g>
109 |         <line
110 |           stroke='rgb(170,170,170)'
111 |           strokeWidth='1'
112 |           x1={this.props.x}
113 |           y1={this.props.y}
114 |           x2={x2}
115 |           y2={y2}
116 |         />
117 |         {this.ticks()}
118 |         {this.label()}
119 |       </g>
120 |     )
121 |   }
122 | }
123 | 
124 | SVGAxis.propTypes = {
125 |   x: PropTypes.number,
126 |   y: PropTypes.number,
127 |   length: PropTypes.number,
128 |   ticks: PropTypes.array,
129 |   tickLength: PropTypes.number,
130 |   rangeLower: PropTypes.number,
131 |   rangeUpper: PropTypes.number,
132 |   vertical: PropTypes.bool,
133 |   label: PropTypes.string
134 | }
135 | 
136 | export default SVGAxis
137 | 


--------------------------------------------------------------------------------
/src/index.js:
--------------------------------------------------------------------------------
  1 | // cbioportal-frontend/src/shared/components/lollipopMutationPlot/LollipopPlotNoTooltip.tsx
  2 | 
  3 | import * as React from 'react'
  4 | import PropTypes from 'prop-types'
  5 | import Lollipop, {lollipopSpec} from './components/Lollipop'
  6 | import Domain, {domainSpec} from './components/Domain'
  7 | import SVGAxis from './components/SVGAxis'
  8 | import Tooltip from './components/Tooltip'
  9 | import Legend from './components/Legend'
 10 | import {jsPDF as JsPDF} from 'jspdf-yworks'
 11 | import svg2pdf from 'svg2pdf.js'
 12 | 
 13 | const LOLLIPOP_ID_CLASS_PREFIX = 'lollipop-'
 14 | const DOMAIN_ID_CLASS_PREFIX = 'domain-'
 15 | 
 16 | const xAxisCandidateTickIntervals = [50, 100, 200, 250, 500, 1000, 2500, 5000, 10000, 25000]
 17 | const yAxisCandidateTickIntervals = [1, 2, 5, 10, 20, 50, 100, 200, 500]
 18 | const lollipopZeroHeight = 10
 19 | const xAxisHeight = 30
 20 | const yAxisWidth = 50
 21 | const geneHeight = 14
 22 | const domainHeight = 24
 23 | 
 24 | const optionsSpec = PropTypes.shape({
 25 |   displayDomainLabel: PropTypes.bool,
 26 |   displayLegend: PropTypes.bool,
 27 |   exportToPDF: PropTypes.bool
 28 | })
 29 | 
 30 | class LollipopPlot extends React.Component {
 31 |   codonToX = (codon) => {
 32 |     return (codon / this.props.xMax) * this.props.vizWidth
 33 |   }
 34 | 
 35 |   countToHeight = count => {
 36 |     return lollipopZeroHeight + Math.min(1, (count / this.yMax())) * this.yAxisHeight()
 37 |   }
 38 | 
 39 |   geneX = () => {
 40 |     return yAxisWidth + 20
 41 |   }
 42 | 
 43 |   geneY = () => {
 44 |     return this.props.vizHeight - geneHeight + 30
 45 |   }
 46 | 
 47 |   domainY = () => {
 48 |     return this.geneY() - ((domainHeight - geneHeight) / 2)
 49 |   }
 50 | 
 51 |   domains = () => {
 52 |     const {domains, options} = this.props
 53 |     return domains ? domains.map((domain, index) => {
 54 |       const x = this.codonToX(domain.startCodon)
 55 |       const width = this.codonToX(domain.endCodon) - x
 56 |       return (
 57 |         <Domain
 58 |           id={'domain_' + index}
 59 |           key={index}
 60 |           x={this.geneX() + x}
 61 |           y={this.domainY()}
 62 |           width={width}
 63 |           height={domainHeight}
 64 |           color={domain.color}
 65 |           label={domain.label}
 66 |           tooltip={domain.tooltip}
 67 |           labelColor={domain.labelColor}
 68 |           spec={domain}
 69 |           displayLabel={options.displayDomainLabel}
 70 |         />
 71 |       )
 72 |     }) : ''
 73 |   }
 74 | 
 75 |   lollipops = () => {
 76 |     const {lollipops, onLollipopClick} = this.props
 77 |     const hoverHeadRadius = 5
 78 |     return lollipops.map((lollipop, i) => {
 79 |       return (<Lollipop
 80 |         key={`${lollipop.codon}-${i}`}
 81 |         id={lollipop.id}
 82 |         x={this.geneX() + this.codonToX(lollipop.codon)}
 83 |         stickBaseY={this.geneY()}
 84 |         stickHeight={this.countToHeight(lollipop.count)}
 85 |         headRadius={2.8}
 86 |         hoverHeadRadius={hoverHeadRadius}
 87 |         label={lollipop.label}
 88 |         headColor={lollipop.color}
 89 |         tooltip={lollipop.tooltip}
 90 |         selected={lollipop.selected}
 91 |         onClick={onLollipopClick}
 92 |       />
 93 |       )
 94 |     })
 95 |   }
 96 | 
 97 |   svgWidth = () => {
 98 |     return this.props.vizWidth + this.geneX() + 30
 99 |   }
100 | 
101 |   svgHeight = () => {
102 |     return this.geneY() + domainHeight + xAxisHeight
103 |   }
104 | 
105 |   getComponentIndex = (classes, classPrefix) => {
106 |     const match = classes.split(/[\s]+/g).map(c => c.match(new RegExp(`^${classPrefix}(.*)$`)))
107 |       .find(x => (x !== null))
108 |     if (!match) {
109 |       return null
110 |     } else {
111 |       return parseInt(match[1], 10)
112 |     }
113 |   }
114 | 
115 |   getDomainIndex = classes => {
116 |     return this.getComponentIndex(classes, DOMAIN_ID_CLASS_PREFIX)
117 |   }
118 | 
119 |   getLollipopIndex = classes => {
120 |     return this.getComponentIndex(classes, LOLLIPOP_ID_CLASS_PREFIX)
121 |   }
122 | 
123 |   yAxisHeight = () => {
124 |     return this.props.vizHeight - domainHeight - lollipopZeroHeight
125 |   }
126 | 
127 |   calculateTickInterval = (candidates, rangeSize, maxTickCount) => {
128 |     let ret
129 |     const tickInterval = candidates.find(c => ((rangeSize / c) < (maxTickCount - 1)))
130 |     if (!tickInterval) {
131 |       ret = 10
132 |       while ((rangeSize / ret) > (maxTickCount - 1)) {
133 |         ret *= 10
134 |       }
135 |     } else {
136 |       ret = tickInterval
137 |     }
138 |     return ret
139 |   }
140 | 
141 |   xAxisTickInterval = () => {
142 |     return this.calculateTickInterval(xAxisCandidateTickIntervals, this.props.xMax, 16)
143 |   }
144 | 
145 |   yAxisTickInterval = () => {
146 |     return this.calculateTickInterval(yAxisCandidateTickIntervals, this.yMax(), 10)
147 |   }
148 | 
149 |   calculateTicks = (tickInterval, rangeSize, labelEvenTicks) => {
150 |     const ret = []
151 |     let nextTick = tickInterval
152 |     while (nextTick < rangeSize) {
153 |       let label
154 |       // add label only for the even ticks
155 |       // but do not add label if it is too close to the end value
156 |       if (labelEvenTicks && (rangeSize - nextTick > (2 * tickInterval) / 3) && (nextTick % (2 * tickInterval) === 0)) {
157 |         label = nextTick + ''
158 |       }
159 |       ret.push({
160 |         position: nextTick,
161 |         label
162 |       })
163 |       nextTick += tickInterval
164 |     }
165 |     return ret
166 |   }
167 | 
168 |   xTicks = () => {
169 |     let ret = []
170 |     // Start and end, always there
171 |     ret.push({
172 |       position: 0,
173 |       label: '0'
174 |     })
175 |     ret.push({
176 |       position: this.props.xMax,
177 |       label: this.props.xMax + 'aa'
178 |     })
179 |     // Intermediate ticks, every other one labeled
180 |     ret = ret.concat(this.calculateTicks(this.xAxisTickInterval(), this.props.xMax, true))
181 |     return ret
182 |   }
183 | 
184 |   yTicks = () => {
185 |     let ret = []
186 |     // Start and end, always there
187 |     ret.push({
188 |       position: 0,
189 |       label: '0'
190 |     })
191 |     ret.push({
192 |       position: this.yMax(),
193 |       label: this.yMaxLabel()
194 |     })
195 |     // Intermediate ticks, unlabeled
196 |     ret = ret.concat(this.calculateTicks(this.yAxisTickInterval(), this.yMax(), false))
197 |     return ret
198 |   }
199 | 
200 |   yMax = () => {
201 |     return this.props.yMax || this.props.lollipops.reduce((max, next) => {
202 |       return Math.max(max, next.count)
203 |     }, 1)
204 |   }
205 | 
206 |   yMaxLabel = () => {
207 |     return (this.props.lollipops.find(lollipop => (lollipop.count > this.yMax())) ? '>= ' : '') + this.yMax()
208 |   }
209 | 
210 |   handleDownloadAsPNG = (hugoGeneSymbol) => {
211 |     const svgElement = document.getElementById('lollipop-svgnode')
212 |     const width = this.svgWidth() + 200
213 |     const height = this.svgHeight()
214 |     const suffix = 'lollipop.pdf'
215 |     const fileName = hugoGeneSymbol ? `${hugoGeneSymbol}-${suffix}` : suffix
216 | 
217 |     // create a new jsPDF instance
218 |     const pdf = new JsPDF('l', 'pt', [width, height])
219 |     // render the svg element
220 |     svg2pdf(svgElement, pdf, {
221 |       xOffset: 0,
222 |       yOffset: 0,
223 |       scale: 1
224 |     })
225 |     // or simply save the created pdf
226 |     pdf.save(`${fileName}`)
227 |   }
228 | 
229 |   renderLegend = (options, domains) => {
230 |     if (options.displayLegend) {
231 |       return <Legend domains={domains} />
232 |     } else {
233 |       return ''
234 |     }
235 |   }
236 | 
237 |   renderExportToPDF = (options, hugoGeneSymbol) => {
238 |     if (options.displayLegend) {
239 |       return (
240 |         <div style={{textAlign: 'left', maxWidth: this.svgWidth() + 200}}>
241 |           <button onClick={() => this.handleDownloadAsPNG(hugoGeneSymbol)}>Save as PDF</button>
242 |         </div>
243 |       )
244 |     }
245 |   }
246 | 
247 |   render() {
248 |     const {options, domains, hugoGeneSymbol} = this.props
249 |     return (
250 |       <React.Fragment>
251 |         {this.renderExportToPDF(options, hugoGeneSymbol)}
252 |         <svg xmlns='http://www.w3.org/2000/svg' width={this.svgWidth() + 200} height={this.svgHeight()}
253 |           className='lollipop-svgnode' id='lollipop-svgnode'>
254 |           <rect
255 |             fill='#FFFFFF'
256 |             x={0}
257 |             y={0}
258 |             width={this.svgWidth()}
259 |             height={this.svgHeight()}
260 |           />
261 |           <rect
262 |             fill='#BABDB6'
263 |             x={this.geneX()}
264 |             y={this.geneY()}
265 |             height={geneHeight}
266 |             width={
267 |               // the x-axis start from 0, so the rectangle size should be (width + 1)
268 |               this.props.vizWidth + 1
269 |             }
270 |           />
271 |           {this.lollipops()}
272 |           {this.domains()}
273 |           {this.renderLegend(options, domains)}
274 |           <SVGAxis
275 |             key='horz'
276 |             x={this.geneX()}
277 |             y={this.geneY() + geneHeight + 10}
278 |             length={this.props.vizWidth}
279 |             tickLength={7}
280 |             rangeLower={0}
281 |             rangeUpper={this.props.xMax}
282 |             ticks={this.xTicks()}
283 |           />
284 |           <SVGAxis
285 |             key='vert'
286 |             x={this.geneX() - 10}
287 |             y={this.geneY() - lollipopZeroHeight - this.yAxisHeight()}
288 |             length={this.yAxisHeight()}
289 |             tickLength={7}
290 |             rangeLower={0}
291 |             rangeUpper={this.yMax()}
292 |             ticks={this.yTicks()}
293 |             vertical={true}
294 |             label={`# ${hugoGeneSymbol} Mutations`}
295 |           />
296 |         </svg>
297 |         <Tooltip id='domainTooltip' />
298 |         <Tooltip id='lollipopTooltip' />
299 |       </React.Fragment>
300 |     )
301 |   }
302 | }
303 | LollipopPlot.defaultProps = {
304 |   options: {
305 |     displayDomainLabel: false,
306 |     displayLegend: true,
307 |     exportToPDF: true
308 |   }
309 | }
310 | 
311 | LollipopPlot.propTypes = {
312 |   lollipops: PropTypes.arrayOf(lollipopSpec),
313 |   domains: PropTypes.arrayOf(domainSpec),
314 |   vizWidth: PropTypes.number,
315 |   vizHeight: PropTypes.number,
316 |   xMax: PropTypes.number,
317 |   yMax: PropTypes.number,
318 |   hugoGeneSymbol: PropTypes.string,
319 |   onLollipopClick: PropTypes.func,
320 |   options: optionsSpec
321 | }
322 | 
323 | export default LollipopPlot
324 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU AFFERO GENERAL PUBLIC LICENSE
  2 |                        Version 3, 19 November 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU Affero General Public License is a free, copyleft license for
 11 | software and other kinds of works, specifically designed to ensure
 12 | cooperation with the community in the case of network server software.
 13 | 
 14 |   The licenses for most software and other practical works are designed
 15 | to take away your freedom to share and change the works.  By contrast,
 16 | our General Public Licenses are intended to guarantee your freedom to
 17 | share and change all versions of a program--to make sure it remains free
 18 | software for all its users.
 19 | 
 20 |   When we speak of free software, we are referring to freedom, not
 21 | price.  Our General Public Licenses are designed to make sure that you
 22 | have the freedom to distribute copies of free software (and charge for
 23 | them if you wish), that you receive source code or can get it if you
 24 | want it, that you can change the software or use pieces of it in new
 25 | free programs, and that you know you can do these things.
 26 | 
 27 |   Developers that use our General Public Licenses protect your rights
 28 | with two steps: (1) assert copyright on the software, and (2) offer
 29 | you this License which gives you legal permission to copy, distribute
 30 | and/or modify the software.
 31 | 
 32 |   A secondary benefit of defending all users' freedom is that
 33 | improvements made in alternate versions of the program, if they
 34 | receive widespread use, become available for other developers to
 35 | incorporate.  Many developers of free software are heartened and
 36 | encouraged by the resulting cooperation.  However, in the case of
 37 | software used on network servers, this result may fail to come about.
 38 | The GNU General Public License permits making a modified version and
 39 | letting the public access it on a server without ever releasing its
 40 | source code to the public.
 41 | 
 42 |   The GNU Affero General Public License is designed specifically to
 43 | ensure that, in such cases, the modified source code becomes available
 44 | to the community.  It requires the operator of a network server to
 45 | provide the source code of the modified version running there to the
 46 | users of that server.  Therefore, public use of a modified version, on
 47 | a publicly accessible server, gives the public access to the source
 48 | code of the modified version.
 49 | 
 50 |   An older license, called the Affero General Public License and
 51 | published by Affero, was designed to accomplish similar goals.  This is
 52 | a different license, not a version of the Affero GPL, but Affero has
 53 | released a new version of the Affero GPL which permits relicensing under
 54 | this license.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                        TERMS AND CONDITIONS
 60 | 
 61 |   0. Definitions.
 62 | 
 63 |   "This License" refers to version 3 of the GNU Affero General Public License.
 64 | 
 65 |   "Copyright" also means copyright-like laws that apply to other kinds of
 66 | works, such as semiconductor masks.
 67 | 
 68 |   "The Program" refers to any copyrightable work licensed under this
 69 | License.  Each licensee is addressed as "you".  "Licensees" and
 70 | "recipients" may be individuals or organizations.
 71 | 
 72 |   To "modify" a work means to copy from or adapt all or part of the work
 73 | in a fashion requiring copyright permission, other than the making of an
 74 | exact copy.  The resulting work is called a "modified version" of the
 75 | earlier work or a work "based on" the earlier work.
 76 | 
 77 |   A "covered work" means either the unmodified Program or a work based
 78 | on the Program.
 79 | 
 80 |   To "propagate" a work means to do anything with it that, without
 81 | permission, would make you directly or secondarily liable for
 82 | infringement under applicable copyright law, except executing it on a
 83 | computer or modifying a private copy.  Propagation includes copying,
 84 | distribution (with or without modification), making available to the
 85 | public, and in some countries other activities as well.
 86 | 
 87 |   To "convey" a work means any kind of propagation that enables other
 88 | parties to make or receive copies.  Mere interaction with a user through
 89 | a computer network, with no transfer of a copy, is not conveying.
 90 | 
 91 |   An interactive user interface displays "Appropriate Legal Notices"
 92 | to the extent that it includes a convenient and prominently visible
 93 | feature that (1) displays an appropriate copyright notice, and (2)
 94 | tells the user that there is no warranty for the work (except to the
 95 | extent that warranties are provided), that licensees may convey the
 96 | work under this License, and how to view a copy of this License.  If
 97 | the interface presents a list of user commands or options, such as a
 98 | menu, a prominent item in the list meets this criterion.
 99 | 
100 |   1. Source Code.
101 | 
102 |   The "source code" for a work means the preferred form of the work
103 | for making modifications to it.  "Object code" means any non-source
104 | form of a work.
105 | 
106 |   A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 | 
111 |   The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form.  A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 | 
122 |   The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities.  However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work.  For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 | 
135 |   The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 | 
139 |   The Corresponding Source for a work in source code form is that
140 | same work.
141 | 
142 |   2. Basic Permissions.
143 | 
144 |   All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met.  This License explicitly affirms your unlimited
147 | permission to run the unmodified Program.  The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work.  This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 | 
152 |   You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force.  You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright.  Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 | 
163 |   Conveying under any other circumstances is permitted solely under
164 | the conditions stated below.  Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 | 
167 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 | 
169 |   No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 | 
175 |   When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 | 
183 |   4. Conveying Verbatim Copies.
184 | 
185 |   You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 | 
193 |   You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 | 
196 |   5. Conveying Modified Source Versions.
197 | 
198 |   You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 | 
202 |     a) The work must carry prominent notices stating that you modified
203 |     it, and giving a relevant date.
204 | 
205 |     b) The work must carry prominent notices stating that it is
206 |     released under this License and any conditions added under section
207 |     7.  This requirement modifies the requirement in section 4 to
208 |     "keep intact all notices".
209 | 
210 |     c) You must license the entire work, as a whole, under this
211 |     License to anyone who comes into possession of a copy.  This
212 |     License will therefore apply, along with any applicable section 7
213 |     additional terms, to the whole of the work, and all its parts,
214 |     regardless of how they are packaged.  This License gives no
215 |     permission to license the work in any other way, but it does not
216 |     invalidate such permission if you have separately received it.
217 | 
218 |     d) If the work has interactive user interfaces, each must display
219 |     Appropriate Legal Notices; however, if the Program has interactive
220 |     interfaces that do not display Appropriate Legal Notices, your
221 |     work need not make them do so.
222 | 
223 |   A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit.  Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 | 
233 |   6. Conveying Non-Source Forms.
234 | 
235 |   You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 | 
240 |     a) Convey the object code in, or embodied in, a physical product
241 |     (including a physical distribution medium), accompanied by the
242 |     Corresponding Source fixed on a durable physical medium
243 |     customarily used for software interchange.
244 | 
245 |     b) Convey the object code in, or embodied in, a physical product
246 |     (including a physical distribution medium), accompanied by a
247 |     written offer, valid for at least three years and valid for as
248 |     long as you offer spare parts or customer support for that product
249 |     model, to give anyone who possesses the object code either (1) a
250 |     copy of the Corresponding Source for all the software in the
251 |     product that is covered by this License, on a durable physical
252 |     medium customarily used for software interchange, for a price no
253 |     more than your reasonable cost of physically performing this
254 |     conveying of source, or (2) access to copy the
255 |     Corresponding Source from a network server at no charge.
256 | 
257 |     c) Convey individual copies of the object code with a copy of the
258 |     written offer to provide the Corresponding Source.  This
259 |     alternative is allowed only occasionally and noncommercially, and
260 |     only if you received the object code with such an offer, in accord
261 |     with subsection 6b.
262 | 
263 |     d) Convey the object code by offering access from a designated
264 |     place (gratis or for a charge), and offer equivalent access to the
265 |     Corresponding Source in the same way through the same place at no
266 |     further charge.  You need not require recipients to copy the
267 |     Corresponding Source along with the object code.  If the place to
268 |     copy the object code is a network server, the Corresponding Source
269 |     may be on a different server (operated by you or a third party)
270 |     that supports equivalent copying facilities, provided you maintain
271 |     clear directions next to the object code saying where to find the
272 |     Corresponding Source.  Regardless of what server hosts the
273 |     Corresponding Source, you remain obligated to ensure that it is
274 |     available for as long as needed to satisfy these requirements.
275 | 
276 |     e) Convey the object code using peer-to-peer transmission, provided
277 |     you inform other peers where the object code and Corresponding
278 |     Source of the work are being offered to the general public at no
279 |     charge under subsection 6d.
280 | 
281 |   A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 | 
285 |   A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling.  In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage.  For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product.  A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 | 
298 |   "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source.  The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 | 
306 |   If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information.  But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 | 
317 |   The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed.  Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 | 
325 |   Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 | 
331 |   7. Additional Terms.
332 | 
333 |   "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law.  If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 | 
342 |   When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it.  (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.)  You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 | 
349 |   Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 | 
353 |     a) Disclaiming warranty or limiting liability differently from the
354 |     terms of sections 15 and 16 of this License; or
355 | 
356 |     b) Requiring preservation of specified reasonable legal notices or
357 |     author attributions in that material or in the Appropriate Legal
358 |     Notices displayed by works containing it; or
359 | 
360 |     c) Prohibiting misrepresentation of the origin of that material, or
361 |     requiring that modified versions of such material be marked in
362 |     reasonable ways as different from the original version; or
363 | 
364 |     d) Limiting the use for publicity purposes of names of licensors or
365 |     authors of the material; or
366 | 
367 |     e) Declining to grant rights under trademark law for use of some
368 |     trade names, trademarks, or service marks; or
369 | 
370 |     f) Requiring indemnification of licensors and authors of that
371 |     material by anyone who conveys the material (or modified versions of
372 |     it) with contractual assumptions of liability to the recipient, for
373 |     any liability that these contractual assumptions directly impose on
374 |     those licensors and authors.
375 | 
376 |   All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10.  If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term.  If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 | 
386 |   If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 | 
391 |   Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 | 
395 |   8. Termination.
396 | 
397 |   You may not propagate or modify a covered work except as expressly
398 | provided under this License.  Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 | 
403 |   However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 | 
410 |   Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 | 
417 |   Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License.  If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 | 
423 |   9. Acceptance Not Required for Having Copies.
424 | 
425 |   You are not required to accept this License in order to receive or
426 | run a copy of the Program.  Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance.  However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work.  These actions infringe copyright if you do
431 | not accept this License.  Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 | 
434 |   10. Automatic Licensing of Downstream Recipients.
435 | 
436 |   Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License.  You are not responsible
439 | for enforcing compliance by third parties with this License.
440 | 
441 |   An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations.  If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 | 
451 |   You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License.  For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 | 
459 |   11. Patents.
460 | 
461 |   A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based.  The
463 | work thus licensed is called the contributor's "contributor version".
464 | 
465 |   A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version.  For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 | 
475 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 | 
480 |   In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement).  To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 | 
487 |   If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients.  "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 | 
501 |   If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 | 
509 |   A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License.  You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 | 
524 |   Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 | 
528 |   12. No Surrender of Others' Freedom.
529 | 
530 |   If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License.  If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all.  For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 | 
540 |   13. Remote Network Interaction; Use with the GNU General Public License.
541 | 
542 |   Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software.  This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 | 
553 |   Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work.  The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 | 
561 |   14. Revised Versions of this License.
562 | 
563 |   The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time.  Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 | 
568 |   Each version is given a distinguishing version number.  If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation.  If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 | 
577 |   If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 | 
582 |   Later license versions may give you additional or different
583 | permissions.  However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 | 
587 |   15. Disclaimer of Warranty.
588 | 
589 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 | 
598 |   16. Limitation of Liability.
599 | 
600 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 | 
610 |   17. Interpretation of Sections 15 and 16.
611 | 
612 |   If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 | 
619 |                      END OF TERMS AND CONDITIONS
620 | 
621 |             How to Apply These Terms to Your New Programs
622 | 
623 |   If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 | 
627 |   To do so, attach the following notices to the program.  It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 | 
632 |     <one line to give the program's name and a brief idea of what it does.>
633 |     Copyright (C) <year>  <name of author>
634 | 
635 |     This program is free software: you can redistribute it and/or modify
636 |     it under the terms of the GNU Affero General Public License as published
637 |     by the Free Software Foundation, either version 3 of the License, or
638 |     (at your option) any later version.
639 | 
640 |     This program is distributed in the hope that it will be useful,
641 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
642 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
643 |     GNU Affero General Public License for more details.
644 | 
645 |     You should have received a copy of the GNU Affero General Public License
646 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
647 | 
648 | Also add information on how to contact you by electronic and paper mail.
649 | 
650 |   If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source.  For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code.  There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 | 
658 |   You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | <http://www.gnu.org/licenses/>.
662 | 


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


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