Este projeto foi inicializado com o aplicativo Create React.
Abaixo, você encontrará algumas informações sobre como executar tarefas comuns.
Você pode encontrar a versão mais recente deste guia aqui.
<title>
public
public
.env
<meta>
no servidornpm start
não detecta alteraçõesnpm test
está pendurado ou trava no macOS Sierranpm run build
sai muito cedonpm run build
falha no Herokunpm run build
falha em minificarCriar o aplicativo React é dividido em dois pacotes:
create-react-app
é um utilitário de linha de comando global que você usa para criar novos projetos.react-scripts
é uma dependência de desenvolvimento nos projetos gerados (incluindo este). Você quase nunca precisa atualizar o próprio create-react-app
: ele delega toda a configuração para react-scripts
.
Quando você executa create-react-app
, ele sempre cria o projeto com a versão mais recente do react-scripts
, para que você obtenha todos os novos recursos e melhorias nos aplicativos recém-criados automaticamente.
Para atualizar um projeto existente para uma nova versão do react-scripts
, abra o Changelog, encontre a versão em que você está atualmente (check package.json
nesta pasta, se não tiver certeza) e aplique as instruções de migração para o mais recente versões.
Na maioria dos casos, batendo na versão react-scripts
no package.json
e executando npm install
(ou yarn install
) nesta pasta deve ser suficiente, mas é bom consultar o Changelog para possíveis alterações de quebra.
Comprometem-se a manter as mudanças de ruptura mínimas para que você possa atualizar react-scripts
com dor.
Estamos sempre abertos ao seu feedback.
Após a criação, seu projeto deve ficar assim:
my-app/
README.md
node_modules/
package.json
public/
index.html
favicon.ico
src/
App.css
App.js
App.test.js
index.css
index.js
logo.svg
Para que o projeto seja construído, esses arquivos devem existir com nomes de arquivos exatos :
public/index.html
é o modelo de página;src/index.js
é o ponto de entrada JavaScript.Você pode excluir ou renomear os outros arquivos.
Você pode criar subdiretos dentro src
. Para reconstruções mais rápidas, apenas os arquivos dentro src
são processados pelo WebPack.
Você precisa colocar quaisquer arquivos JS e CSS dentro src
, caso contrário, o Webpack não os verá.
Somente arquivos dentro public
podem ser usados em public/index.html
.
Leia as instruções abaixo para usar ativos de JavaScript e HTML.
No entanto, você pode criar mais diretórios de nível superior.
Eles não serão incluídos na construção da produção para que você possa usá -los para coisas como documentação.
No diretório do projeto, você pode executar:
npm start
Executa o aplicativo no modo de desenvolvimento.
Abra http: // localhost: 3000 para visualizá -lo no navegador.
A página será recarregada se você fizer edições.
Você também verá erros de fiapos no console.
npm test
Inicia o corredor de teste no modo de relógio interativo.
Consulte a seção sobre como executar testes para obter mais informações.
npm run build
Construa o aplicativo para produção na pasta build
.
Os pacotes corretamente reagem no modo de produção e otimiza a construção para obter o melhor desempenho.
A construção é minificada e os nomes de arquivos incluem os hashes.
Seu aplicativo está pronto para ser implantado!
Consulte a seção sobre implantação para obter mais informações.
npm run eject
Nota: Esta é uma operação unidirecional. Depois de eject
, você não pode voltar!
Se você não estiver satisfeito com a ferramenta de compilação e as opções de configuração, poderá eject
a qualquer momento. Este comando removerá a dependência de compilação única do seu projeto.
Em vez disso, ele copiará todos os arquivos de configuração e as dependências transitivas (Webpack, Babel, Eslint, etc.) diretamente em seu projeto, para que você tenha controle total sobre eles. Todos os comandos, exceto que eject
ainda funcionarão, mas apontarão para os scripts copiados para que você possa ajustá -los. Neste ponto, você está sozinho.
Você nunca precisa usar eject
. O conjunto de recursos com curadoria é adequado para implantações pequenas e médias, e você não deve se sentir obrigado a usar esse recurso. No entanto, entendemos que essa ferramenta não seria útil se você não pudesse personalizá -la quando estiver pronto para isso.
Por padrão, o projeto gerado suporta todos os navegadores modernos.
O suporte ao Internet Explorer 9, 10 e 11 requer poli -filos.
Este projeto suporta um superconjunto do mais recente padrão JavaScript.
Além dos recursos de sintaxe ES6, ele também suporta:
Saiba mais sobre diferentes estágios da proposta.
Embora recomendamos o uso de propostas experimentais com alguma cautela, o Facebook usa fortemente esses recursos no código do produto, por isso pretendemos fornecer codemodos se alguma dessas propostas mudar no futuro.
Observe que este projeto não inclui poli -preenchimento por padrão.
Se você usar outros recursos ES6+ que precisarem de suporte de tempo de execução (como Array.from()
ou Symbol
), verifique se você está incluindo os poli -preenchimentos apropriados manualmente ou se os navegadores que você está direcionando já os suportam.
Para configurar o destaque da sintaxe em seu editor de texto favorito, acesse a página de documentação de Babel relevante e siga as instruções. Alguns dos editores mais populares são cobertos.
Nota: Este recurso está disponível com
[email protected]
e superior.
Também funciona apenas com o NPM 3 ou superior.
Alguns editores, incluindo o código sublime de texto, átomo e Visual Studio, fornecem plugins para ESLint.
Eles não são necessários para o linhagem. Você deve ver a saída do linhador diretamente no seu terminal, bem como no console do navegador. No entanto, se você preferir que os resultados dos fiapos apareçam diretamente no seu editor, há algumas etapas extras que você pode fazer.
Você precisaria instalar um plug -in ESLint para o seu editor primeiro. Em seguida, adicione um arquivo chamado .eslintrc
à raiz do projeto:
{
"extends" : "react-app"
}
Agora seu editor deve relatar os avisos de linha.
Observe que, mesmo se você editar ainda mais seu arquivo .eslintrc
, essas alterações afetarão apenas a integração do editor . Eles não afetarão a saída de fiapos de terminal e navegador. Isso ocorre porque o Create React App fornece intencionalmente um conjunto mínimo de regras que encontram erros comuns.
Se você deseja aplicar um estilo de codificação para o seu projeto, considere usar as regras mais bonitas em vez de ESLint.
Atualmente, esse recurso é suportado apenas pelo Código do Visual Studio e pela WebStorm.
O Código do Visual Studio e o WebStorm suportam a depuração da caixa com o aplicativo Create React. Isso permite que você, como desenvolvedor, escreva e depure seu código REACT sem sair do editor, e o mais importante é que você permite que você tenha um fluxo de trabalho de desenvolvimento contínuo, onde a troca de contexto é mínima, pois você não precisa alternar entre as ferramentas.
Você precisaria ter a versão mais recente do código VS e do código VS Code Chrome Depury Extension instalado.
Em seguida, adicione o bloco abaixo ao seu arquivo launch.json
e coloque -o dentro da pasta .vscode
no diretório raiz do seu aplicativo.
{
"version" : " 0.2.0 " ,
"configurations" : [
{
"name" : " Chrome " ,
"type" : " chrome " ,
"request" : " launch " ,
"url" : " http://localhost:3000 " ,
"webRoot" : " ${workspaceRoot}/src " ,
"sourceMapPathOverrides" : {
"webpack:///src/*" : " ${webRoot}/* "
}
}
]
}
NOTA: O URL pode ser diferente se você fizer ajustes através das variáveis de ambiente de host ou porta.
Inicie seu aplicativo executando npm start
e comece a depurar o código VS pressionando F5
ou clicando no ícone de depuração verde. Agora você pode escrever código, definir pontos de interrupção, fazer alterações no código e depurar seu código recém -modificado - tudo do seu editor.
Tendo problemas com a depuração do código VS? Por favor, consulte o guia de solução de problemas.
Você precisaria ter a Webstorm e JetBrains IDE Suporte Extensão Chrome instalada.
No menu Webstorm, Run
Edit Configurations...
Em seguida, clique em +
e selecione JavaScript Debug
. Cole http://localhost:3000
no campo URL e salve a configuração.
NOTA: O URL pode ser diferente se você fizer ajustes através das variáveis de ambiente de host ou porta.
Inicie seu aplicativo executando npm start
, pressione ^D
no macOS ou F9
no Windows e Linux ou clique no ícone de depuração verde para começar a depurar na Webstorm.
Da mesma forma que você pode depurar sua inscrição no Intellij Idea Ultimate, Phpstorm, Pycharm Pro e Rubymine.
Prettier é um formatador de código opinativo com suporte para JavaScript, CSS e JSON. Com o mais bonito, você pode formatar o código que você escreve automaticamente para garantir um estilo de código dentro do seu projeto. Consulte a página do Github do litorre para obter mais informações e observe esta página para vê -la em ação.
Para formatar nosso código sempre que fizermos um compromisso no Git, precisamos instalar as seguintes dependências:
npm install --save husky lint-staged prettier
Como alternativa, você pode usar yarn
:
yarn add husky lint-staged prettier
husky
facilita o uso de Githooks como se fossem scripts NPM.lint-staged
nos permite executar scripts em arquivos encenados no Git. Veja esta postagem do blog sobre meios de fia, para saber mais sobre isso.prettier
é o formatador JavaScript que executaremos antes das confirmações. Agora, podemos garantir que cada arquivo seja formatado corretamente adicionando algumas linhas ao package.json
na raiz do projeto.
Adicione o seguinte campo à seção package.json
:
+ "husky": {
+ "hooks": {
+ "pre-commit": "lint-staged"
+ }
+ }
Em seguida, adicionamos um campo de 'fiagsed' ao package.json
, por exemplo:
"dependencies": {
// ...
},
+ "lint-staged": {
+ "src/**/*.{js,jsx,json,css}": [
+ "prettier --single-quote --write",
+ "git add"
+ ]
+ },
"scripts": {
Agora, sempre que você se compromete, o mais bonito formate os arquivos alterados automaticamente. Você também pode executar ./node_modules/.bin/prettier --single-quote --write "src/**/*.{js,jsx}"
para formatar todo o seu projeto pela primeira vez.
Em seguida, você pode querer integrar mais bonito em seu editor favorito. Leia a seção sobre integração do editor na página Github mais bonita.
<title>
Você pode encontrar o arquivo HTML de origem na pasta public
do projeto gerado. Você pode editar a tag <title>
para alterar o título de "React App" para qualquer outra coisa.
Observe que normalmente você não edita arquivos na pasta public
com muita frequência. Por exemplo, a adição de uma folha de estilo é feita sem tocar no HTML.
Se você precisar atualizar dinamicamente o título da página com base no conteúdo, poderá usar a API document.title
do navegador. Para cenários mais complexos quando você deseja alterar o título dos componentes do React, você pode usar o React Helmet, uma biblioteca de terceiros.
Se você usar um servidor personalizado para o seu aplicativo em produção e deseja modificar o título antes de ele ser enviado para o navegador, você poderá seguir o conselho nesta seção. Como alternativa, você pode pré-construir cada página como um arquivo HTML estático que carrega o pacote JavaScript, que é coberto aqui.
O projeto gerado inclui o React e o Reactdom como dependências. Ele também inclui um conjunto de scripts usados pelo Create React App como uma dependência de desenvolvimento. Você pode instalar outras dependências (por exemplo, roteador React) com npm
:
npm install --save react-router-dom
Como alternativa, você pode usar yarn
:
yarn add react-router-dom
Isso funciona para qualquer biblioteca, não apenas react-router-dom
.
Esta configuração do projeto suporta módulos ES6 graças ao Webpack.
Embora você ainda possa usar require()
e module.exports
, incentivamos você a usar import
e export
.
Por exemplo:
Button.js
import React , { Component } from 'react' ;
class Button extends Component {
render ( ) {
// ...
}
}
export default Button ; // Don’t forget to use export default!
DangerButton.js
import React , { Component } from 'react' ;
import Button from './Button' ; // Import a component from another file
class DangerButton extends Component {
render ( ) {
return < Button color = "red" / > ;
}
}
export default DangerButton ;
Esteja ciente da diferença entre as exportações padrão e nomeadas. É uma fonte comum de erros.
Sugerimos que você continue usando importações e exportações padrão quando um módulo exporta apenas uma única coisa (por exemplo, um componente). É isso que você recebe quando usa export default Button
e import Button from './Button'
.
As exportações nomeadas são úteis para módulos de utilidade que exportam várias funções. Um módulo pode ter no máximo uma exportação padrão e tantas exportações nomeadas quanto quiser.
Saiba mais sobre os módulos ES6:
Em vez de baixar o aplicativo inteiro antes que os usuários possam usá -lo, a divisão de código permite dividir seu código em pequenos pedaços que você pode carregar sob demanda.
Esta configuração do projeto suporta divisão de código via Dynamic import()
. Sua proposta está no estágio 3. O formulário import()
do tipo função assume o nome do módulo como um argumento e retorna uma Promise
que sempre resolve o objeto de namespace do módulo.
Aqui está um exemplo:
moduleA.js
const moduleA = 'Hello' ;
export { moduleA } ;
App.js
import React , { Component } from 'react' ;
class App extends Component {
handleClick = ( ) => {
import ( './moduleA' )
. then ( ( { moduleA } ) => {
// Use moduleA
} )
. catch ( err => {
// Handle failure
} ) ;
} ;
render ( ) {
return (
< div >
< button onClick = { this . handleClick } > Load < / button >
< / div >
) ;
}
}
export default App ;
Isso fará com que moduleA.js
e todas as suas dependências exclusivas como um pedaço separado que carregam apenas depois que o usuário clica no botão 'Carregar'.
Você também pode usá -lo com sintaxe async
/ await
, se preferir.
Se você estiver usando o Router React, consulte este tutorial sobre como usar a divisão de código com ele. Você pode encontrar o repositório do Companion Github aqui.
Confira também a seção de divisão de código na documentação do React.
Esta configuração do projeto usa o WebPack para lidar com todos os ativos. O WebPack oferece uma maneira personalizada de "estender" o conceito de import
além do JavaScript. Para expressar que um arquivo JavaScript depende de um arquivo CSS, você precisa importar o CSS do arquivo JavaScript :
Button.css
. Button {
padding : 20 px ;
}
Button.js
import React , { Component } from 'react' ;
import './Button.css' ; // Tell Webpack that Button.js uses these styles
class Button extends Component {
render ( ) {
// You can use them as regular CSS styles
return < div className = "Button" / > ;
}
}
Isso não é necessário para o React , mas muitas pessoas acham esse recurso conveniente. Você pode ler sobre os benefícios dessa abordagem aqui. No entanto, você deve estar ciente de que isso torna seu código menos portátil para outras ferramentas e ambientes de construção do que o webpack.
No desenvolvimento, expressar dependências dessa maneira permite que seus estilos sejam recarregados em tempo real enquanto você as edita. Na produção, todos os arquivos CSS serão concatenados em um único arquivo .css
minificado na saída de compilação.
Se você estiver preocupado em usar a semântica específica do Webpack, pode colocar todo o seu CSS diretamente no src/index.css
. Ele ainda seria importado do src/index.js
, mas você sempre poderá remover essa importação se mais tarde migrar para uma ferramenta de construção diferente.
Nota: Este recurso está disponível com
[email protected]
e superior.
Este projeto suporta módulos CSS juntamente com folhas de estilo regulares usando a Convenção de Nomeação de Arquivos [name].module.css
. Os módulos CSS permitem o escopo de CSS criando automaticamente um nome de classe exclusivo do formato [filename]_[classname]__[hash]
.
Dica: Se você deseja pré -processar uma folha de estilo com SASS, siga as instruções de instalação e altere a extensão do arquivo da folha de estilo da seguinte forma:
[name].module.scss
ou[name].module.sass
.
Os módulos CSS permitem usar o mesmo nome de classe CSS em diferentes arquivos sem se preocupar em nomear confrontos. Saiba mais sobre os módulos CSS aqui.
Button.module.css
. error {
background-color : red;
}
another-stylesheet.css
. error {
color : red;
}
Button.js
import React , { Component } from 'react' ;
import styles from './Button.module.css' ; // Import css modules stylesheet as styles
import './another-stylesheet.css' ; // Import regular stylesheet
class Button extends Component {
render ( ) {
// reference as a js object
return < button className = { styles . error } > Error Button < / button > ;
}
}
Sem conflitos de outros nomes de classe .error
<!-- This button has red background but not red text -->
< button class =" Button_error_ax7yz " > </ div >
Este é um recurso opcional. As folhas de estilo e os arquivos CSS regulares <link>
são totalmente suportadas. Os módulos CSS são ativados para arquivos que terminam com a extensão .module.css
.
Nota: Este recurso está disponível com
[email protected]
e superior.
Geralmente, recomendamos que você não reutilize as mesmas classes CSS em diferentes componentes. Por exemplo, em vez de usar uma classe .Button
CSS em <AcceptButton>
e <RejectButton>
componentes, recomendamos criar um componente <Button>
com seus próprios estilos .Button
, que ambos <AcceptButton>
e <RejectButton>
podem renderizar (mas não herdar).
Seguir essa regra geralmente torna os pré -processadores do CSS menos úteis, pois recursos como mixins e nidificação são substituídos pela composição do componente. Você pode, no entanto, integrar um pré -processador CSS se achar valioso.
Para usar o SASS, primeiro instale node-sass
:
$ npm install node-sass --save
$ # or
$ yarn add node-sass
Agora você pode renomear src/App.css
para src/App.scss
e atualizar src/App.js
para importar src/App.scss
. Este arquivo e qualquer outro arquivo serão compilados automaticamente se importados com a extensão .scss
ou .sass
.
Para compartilhar variáveis entre os arquivos SASS, você pode usar as importações SASS. Por exemplo, src/App.scss
e outros arquivos de estilo de componente podem incluir @import "./shared.scss";
com definições variáveis.
Isso permitirá que você faça importações como
@import ' styles/_colors.scss ' ; // assuming a styles directory under src/
@import ' ~nprogress/nprogress ' ; // importing a css file from the nprogress node module
Dica: você também pode optar por usar esse recurso com módulos CSS!
Nota: Você deve prefixar as importações de
node_modules
com~
conforme exibido acima.
Este projeto configura o seu CSS e adiciona prefixos de fornecedores automaticamente através do Autoprefixer para que você não precise se preocupar com isso.
Suporte para novos recursos CSS, como all
as propriedades, propriedades break
, propriedades personalizadas e intervalos de consultas de mídia, são automaticamente policiletáveis para adicionar suporte para navegadores mais antigos.
Você pode personalizar seus navegadores de suporte de destino ajustando a tecla browserslist
no package.json
acordando a especificação do BrowSerSlist.
Por exemplo, isso:
. App {
display : flex;
flex-direction : row;
align-items : center;
}
torna -se o seguinte:
. App {
display : -webkit-box;
display : -ms-flexbox;
display : flex;
-webkit-box-orient : horizontal;
-webkit-box-direction : normal;
-ms-flex-direction : row;
flex-direction : row;
-webkit-box-align : center;
-ms-flex-align : center;
align-items : center;
}
Se você precisar desativar a opção automática por algum motivo, siga esta seção.
O prefixação do layout da grade do CSS é desativado por padrão, mas não retirará o prefixo manual. Se você deseja optar por prefixar da grade CSS, primeiro se familiarize sobre suas limitações.
Para ativar o prefixo da grade CSS, adicione /* autoprefixer grid: on */
para a parte superior do seu arquivo CSS.
Com o Webpack, o uso de ativos estáticos como imagens e fontes funciona de maneira semelhante ao CSS.
Você pode import
um arquivo correto em um módulo JavaScript . Isso diz a Webpack para incluir esse arquivo no pacote. Ao contrário das importações do CSS, a importação de um arquivo fornece um valor de string. Este valor é o caminho final que você pode referir em seu código, por exemplo, como o atributo src
de uma imagem ou o href
de um link para um PDF.
Para reduzir o número de solicitações ao servidor, a importação de imagens inferiores a 10.000 bytes retorna um URI de dados em vez de um caminho. Isso se aplica às seguintes extensões de arquivo: BMP, GIF, JPG, JPEG e PNG. Os arquivos SVG são excluídos devido ao #1153.
Aqui está um exemplo:
import React from 'react' ;
import logo from './logo.png' ; // Tell Webpack this JS file uses this image
console . log ( logo ) ; // /logo.84287d09.png
function Header ( ) {
// Import result is the URL of your image
return < img src = { logo } alt = "Logo" / > ;
}
export default Header ;
Isso garante que, quando o projeto for construído, o WebPack moverá corretamente as imagens para a pasta Build e nos fornece caminhos corretos.
Isso também funciona no CSS:
. Logo {
background-image : url (. / logo.png);
}
O Webpack encontra todas as referências de módulo relativo no CSS (elas começam com ./
) e as substitui pelos caminhos finais do pacote compilado. Se você fizer um erro de digitação ou excluir acidentalmente um arquivo importante, verá um erro de compilação, assim como quando você importa um módulo JavaScript inexistente. Os nomes finais de arquivo no pacote compilado são gerados pelo WebPack a partir de hashes de conteúdo. Se o conteúdo do arquivo mudar no futuro, o WebPack fornecerá um nome diferente na produção, para que você não precise se preocupar com o cache de ativos de longo prazo.
Esteja ciente de que este também é um recurso personalizado do Webpack.
Não é necessário para o React , mas muitas pessoas gostam (e o React Native usa um mecanismo semelhante para imagens).
Uma maneira alternativa de lidar com ativos estáticos é descrita na próxima seção.
Nota: Este recurso está disponível com
[email protected]
e superior.
Uma maneira de adicionar arquivos SVG foi descrita na seção acima. Você também pode importar SVGs diretamente como componentes do React. Você pode usar qualquer uma das duas abordagens. No seu código, seria assim:
import { ReactComponent as Logo } from './logo.svg' ;
const App = ( ) => (
< div >
{ /* Logo is an actual React component */ }
< Logo / >
< / div >
) ;
Isso é útil se você não deseja carregar SVG como um arquivo separado. Não se esqueça dos aparelhos encaracolados na importação! O nome de importação ReactComponent
é especial e informa ao Create React App que você deseja um componente React que renderize um SVG, em vez de seu nome de arquivo.
public
Nota: Este recurso está disponível com
[email protected]
e superior.
A pasta public
contém o arquivo HTML para que você possa ajustá -lo, por exemplo, para definir o título da página. A tag <script>
com o código compilado será adicionada automaticamente durante o processo de construção.
Você também pode adicionar outros ativos à pasta public
.
Observe que normalmente o incentivamos a import
ativos nos arquivos JavaScript. Por exemplo, consulte as seções sobre como adicionar uma folha de estilo e adicionar imagens e fontes. Este mecanismo fornece vários benefícios:
No entanto, há uma escotilha de fuga que você pode usar para adicionar um ativo fora do sistema de módulos.
Se você colocar um arquivo na pasta public
, ele não será processado pelo Webpack. Em vez disso, será copiado na pasta de construção intocada. Para fazer referência a ativos na pasta public
, você precisa usar uma variável especial chamada PUBLIC_URL
.
Inside index.html
, você pode usá -lo assim:
< link rel =" shortcut icon " href =" %PUBLIC_URL%/favicon.ico " >
Somente arquivos dentro da pasta public
serão acessíveis por %PUBLIC_URL%
prefixo. Se você precisar usar um arquivo do src
ou node_modules
, precisará copiá -lo lá para especificar explicitamente sua intenção de tornar esse arquivo uma parte da compilação.
Quando você executa npm run build
, o Create React App substituirá %PUBLIC_URL%
por um caminho absoluto correto, para que seu projeto funcione, mesmo se você usar o roteamento do lado do cliente ou hospedá-lo em um URL sem raios.
No código JavaScript, você pode usar process.env.PUBLIC_URL
para fins semelhantes:
render ( ) {
// Note: this is an escape hatch and should be used sparingly!
// Normally we recommend using `import` for getting asset URLs
// as described in “Adding Images and Fonts” above this section.
return < img src = { process . env . PUBLIC_URL + '/img/logo.png' } / > ;
}
Lembre -se de que as desvantagens dessa abordagem:
public
é pós-processado ou minificado.public
Normalmente, recomendamos a importação de folhas de estilo, imagens e fontes do JavaScript. A pasta public
é útil como uma solução alternativa para vários casos menos comuns:
manifest.webmanifest
.pace.js
fora do código agrupado.<script>
. Observe que, se você adicionar um <script>
que declara variáveis globais, também precisará ler a próxima seção sobre usá -las.
Quando você inclui um script no arquivo HTML que define variáveis globais e tenta usar uma dessas variáveis no código, o linter reclamará porque não pode ver a definição da variável.
Você pode evitar isso lendo a variável global explicitamente a partir do objeto window
, por exemplo:
const $ = window . $ ;
Isso torna óbvio que você está usando uma variável global intencionalmente, e não por causa de um erro de digitação.
Como alternativa, você pode forçar o linhador a ignorar qualquer linha adicionando // eslint-disable-line
depois dela.
Você não precisa usar o ReactStrap juntamente com o React, mas é uma biblioteca popular para integrar o bootstrap aos aplicativos React. Se você precisar, você pode integrá -lo ao aplicativo Create React, seguindo estas etapas:
Instale o ReactStrap e o Bootstrap do NPM. O ReactStrap não inclui o Bootstrap CSS, então isso precisa ser instalado também:
npm install --save reactstrap bootstrap@4
Como alternativa, você pode usar yarn
:
yarn add bootstrap@4 reactstrap
Importar CSS de Bootstrap e Opcionalmente o tema de inicialização CSS no início do seu arquivo src/index.js
:
import 'bootstrap/dist/css/bootstrap.css' ;
// Put any other imports below so that CSS from your
// components takes precedence over default styles.
Importar componentes ReactStrap necessários no arquivo src/App.js
ou seus arquivos de componentes personalizados:
import { Button } from 'reactstrap' ;
Agora você está pronto para usar os componentes do ReactStrap importado na hierarquia de componentes definidos no método Render. Aqui está um exemplo App.js
refeito usando o ReactStrap.
Nota: Este recurso está disponível com
[email protected]
e superior.
Às vezes, pode ser necessário ajustar os estilos visuais do bootstrap (ou pacote equivalente).
A partir do [email protected]
, você pode importar arquivos .scss
. Isso possibilita o uso das variáveis SASS embutidas de um pacote para preferências de estilo global.
Para personalizar o bootstrap, crie um arquivo chamado src/custom.scss
(ou similar) e importe a folha de estilo de origem do bootstrap. Adicione qualquer substituição antes do (s) arquivo (s) importado (s). Você pode fazer referência à documentação do Bootstrap para os nomes das variáveis disponíveis.
// Override default variables before the import
$body-bg : #000 ;
// Import Bootstrap and its default variables
@import ' ~bootstrap/scss/bootstrap.scss ' ;
Nota: Você deve prefixar as importações de
node_modules
com~
conforme exibido acima.
Por fim, importe o arquivo .scss
recém -criado em vez do bootstrap padrão .css
no início do seu arquivo src/index.js
, por exemplo:
import './custom.scss' ;
O fluxo é um verificador do tipo estático que ajuda a escrever código com menos bugs. Confira esta introdução ao uso de tipos estáticos em JavaScript se você for novo nesse conceito.
As versões recentes do fluxo trabalham com os projetos de aplicativos Create React prontos para uso.
Para adicionar fluxo a um projeto de aplicativo Create React, siga estas etapas:
npm install --save flow-bin
(ou yarn add flow-bin
)."flow": "flow"
à seção scripts
do seu package.json
.npm run flow init
(ou yarn flow init
) para criar um arquivo .flowconfig
no diretório raiz.// @flow
a todos os arquivos que você deseja digitar (por exemplo, src/App.js
). Agora você pode executar npm run flow
(ou yarn flow
) para verificar os arquivos quanto a erros de tipo. Opcionalmente, você pode usar um IDE como o Nuclide para uma experiência melhor integrada. No futuro, planejamos integrá -lo ao aplicativo Create React ainda mais de perto.
Para saber mais sobre o fluxo, consulte sua documentação.
O relé é uma estrutura para a criação de aplicativos de reação orientados a dados alimentados pelo GraphQL. O atual candidato a revezamento trabalha com projetos de aplicativos Create React prontos para uso usando macros Babel. Basta configurar seu projeto conforme estabelecido na documentação do relé e, em seguida, verifique se você tem uma versão do plug -in Babel, fornecendo a macro.
Para adicioná -lo, execute:
npm install --save --dev babel-plugin-relay@dev
Como alternativa, você pode usar yarn
:
yarn upgrade babel-plugin-relay@dev
Em seguida, onde quer que você use a tag de modelo graphql
, importe a macro:
import graphql from 'babel-plugin-relay/macro' ;
// instead of:
// import { graphql } from "babel-plugin-relay"
graphql `
query UserQuery {
viewer {
id
}
}
` ;
Para saber mais sobre o relé, confira sua documentação.
Create React App não prescreve uma solução de roteamento específica, mas o Router React é o mais popular.
Para adicioná -lo, execute:
npm install --save react-router-dom
Como alternativa, você pode usar yarn
:
yarn add react-router-dom
Para tentar, exclua todo o código no src/App.js
e substitua -o por qualquer um dos exemplos em seu site. O exemplo básico é um bom lugar para começar.
Observe que pode ser necessário configurar seu servidor de produção para oferecer suporte ao roteamento do lado do cliente antes de implantar seu aplicativo.
Nota: Este recurso está disponível com
[email protected]
e superior.
Seu projeto pode consumir variáveis declaradas em seu ambiente como se fossem declaradas localmente em seus arquivos JS. Por padrão, você terá NODE_ENV
definido para você e quaisquer outras variáveis de ambiente que começam com REACT_APP_
.
As variáveis de ambiente são incorporadas durante o tempo de construção . Como o Create React App produz um pacote estático HTML/CSS/JS, ele não pode lê -los em tempo de execução. Para lê -los em tempo de execução, você precisaria carregar HTML na memória no servidor e substituir os espaços reservados em tempo de execução, como descrito aqui. Como alternativa, você pode reconstruir o aplicativo no servidor sempre que alterá -lo.
NOTA: Você deve criar variáveis de ambiente personalizadas começando com
REACT_APP_
. Quaisquer outras variáveis, excetoNODE_ENV
serão ignoradas para evitar expor acidentalmente uma chave privada na máquina que pode ter o mesmo nome. A alteração de qualquer variável de ambiente exigirá que você reinicie o servidor de desenvolvimento se estiver em execução.
Essas variáveis de ambiente serão definidas para você no process.env
. Por exemplo, ter uma variável de ambiente nomeada REACT_APP_SECRET_CODE
será exposta no seu js como process.env.REACT_APP_SECRET_CODE
.
Há também uma variável de ambiente interno especial chamada NODE_ENV
. Você pode lê -lo em process.env.NODE_ENV
. Quando você executa npm start
, ele é sempre igual a 'development'
, quando você executa npm test
, é sempre igual a 'test'
e, quando você executa npm run build
para fazer um pacote de produção, é sempre igual a 'production'
. Você não pode substituir NODE_ENV
manualmente. Isso impede os desenvolvedores de implantar acidentalmente uma construção lenta de desenvolvimento na produção.
Essas variáveis de ambiente podem ser úteis para exibir informações condicionalmente com base em onde o projeto é implantado ou consumindo dados confidenciais que vive fora do controle da versão.
Primeiro, você precisa ter variáveis de ambiente definidas. Por exemplo, digamos que você queira consumir um segredo definido no ambiente dentro de um <form>
:
render ( ) {
return (
< div >
< small > You are running this application in < b > { process . env . NODE_ENV } < / b > mode. < / small >
< form >
< input type = "hidden" defaultValue = { process . env . REACT_APP_SECRET_CODE } / >
< / form >
< / div >
) ;
}
Durante a construção, process.env.REACT_APP_SECRET_CODE
será substituído pelo valor atual da variável de ambiente REACT_APP_SECRET_CODE
. Lembre -se de que a variável NODE_ENV
será definida para você automaticamente.
Quando você carrega o aplicativo no navegador e inspeciona o <input>
, você verá seu valor definido como abcdef
, e o texto em negrito mostrará o ambiente fornecido ao usar npm start
:
< div >
< small > You are running this application in < b > development </ b > mode. </ small >
< form >
< input type =" hidden " value =" abcdef " />
</ form >
</ div >
O formulário acima está procurando uma variável chamada REACT_APP_SECRET_CODE
do ambiente. Para consumir esse valor, precisamos defini -lo no ambiente. Isso pode ser feito usando duas maneiras: no seu shell ou em um arquivo .env
. Ambas as maneiras são descritas nas próximas seções.
Ter acesso ao NODE_ENV
também é útil para executar ações condicionalmente:
if ( process . env . NODE_ENV !== 'production' ) {
analytics . disable ( ) ;
}
Quando você compila o aplicativo com npm run build
, a etapa de minificação retirará essa condição e o pacote resultante será menor.
Nota: Este recurso está disponível com
[email protected]
e superior.
Você também pode acessar as variáveis de ambiente começando com REACT_APP_
no public/index.html
. Por exemplo:
< title > %REACT_APP_WEBSITE_NAME% </ title >
Observe que as advertências da seção acima se aplicam:
NODE_ENV
e PUBLIC_URL
), os nomes das variáveis devem começar com REACT_APP_
para funcionar.A definição de variáveis de ambiente pode variar entre os sistemas operacionais. Também é importante saber que essa maneira é temporária para a vida da sessão da concha.
set " REACT_APP_SECRET_CODE = abcdef " && npm start
(Nota: citações em torno da atribuição de variáveis são necessárias para evitar um espaço em branco à direita.)
( $ env: REACT_APP_SECRET_CODE = " abcdef " ) -and (npm start)
REACT_APP_SECRET_CODE=abcdef npm start
.env
Nota: Este recurso está disponível com
[email protected]
e superior.
Para definir variáveis de ambiente permanente, crie um arquivo chamado .env
na raiz do seu projeto:
REACT_APP_SECRET_CODE=abcdef
NOTA: Você deve criar variáveis de ambiente personalizadas começando com
REACT_APP_
. Quaisquer outras variáveis, excetoNODE_ENV
serão ignoradas para evitar expor acidentalmente uma chave privada na máquina que pode ter o mesmo nome. A alteração de qualquer variável de ambiente exigirá que você reinicie o servidor de desenvolvimento se estiver em execução.
Os arquivos .env
devem ser verificados no controle de origem (com a exclusão de .env*.local
).
.env
podem ser usados?Note: this feature is available with
[email protected]
and higher .
.env
: Default..env.local
: Local overrides. This file is loaded for all environments except test..env.development
, .env.test
, .env.production
: Environment-specific settings..env.development.local
, .env.test.local
, .env.production.local
: Local overrides of environment-specific settings.Files on the left have more priority than files on the right:
npm start
: .env.development.local
, .env.development
, .env.local
, .env
npm run build
: .env.production.local
, .env.production
, .env.local
, .env
npm test
: .env.test.local
, .env.test
, .env
(note .env.local
is missing) These variables will act as the defaults if the machine does not explicitly set them.
Please refer to the dotenv documentation for more details.
Note: If you are defining environment variables for development, your CI and/or hosting platform will most likely need these defined as well. Consult their documentation how to do this. For example, see the documentation for Travis CI or Heroku.
.env
Note: this feature is available with
[email protected]
and higher.
Expand variables already on your machine for use in your .env
file (using dotenv-expand).
For example, to get the environment variable npm_package_version
:
REACT_APP_VERSION=$npm_package_version
# also works:
# REACT_APP_VERSION=${npm_package_version}
Or expand variables local to the current .env
file:
DOMAIN=www.example.com
REACT_APP_FOO=$DOMAIN/foo
REACT_APP_BAR=$DOMAIN/bar
Some popular libraries use decorators in their documentation.
Create React App intentionally doesn't support decorator syntax at the moment because:
However in many cases you can rewrite decorator-based code without decorators just as fine.
Please refer to these two threads for reference:
Create React App will add decorator support when the specification advances to a stable stage.
React doesn't prescribe a specific approach to data fetching, but people commonly use either a library like axios or the fetch()
API provided by the browser.
The global fetch
function allows you to easily make AJAX requests. It takes in a URL as an input and returns a Promise
that resolves to a Response
object. You can find more information about fetch
here.
A Promise represents the eventual result of an asynchronous operation, you can find more information about Promises here and here. Both axios and fetch()
use Promises under the hood. You can also use the async / await
syntax to reduce the callback nesting.
Make sure the fetch()
API and Promises are available in your target audience's browsers. For example, support in Internet Explorer requires a polyfill.
You can learn more about making AJAX requests from React components in the FAQ entry on the React website.
These tutorials will help you to integrate your app with an API backend running on another port, using fetch()
to access it.
Check out this tutorial. You can find the companion GitHub repository here.
Check out this tutorial. You can find the companion GitHub repository here.
API Platform is a framework designed to build API-driven projects. It allows to create hypermedia and GraphQL APIs in minutes. It is shipped with an official Progressive Web App generator as well as a dynamic administration interface, both built for Create React App. Check out this tutorial.
Note: this feature is available with
[email protected]
and higher.
People often serve the front-end React app from the same host and port as their backend implementation.
For example, a production setup might look like this after the app is deployed:
/ - static server returns index.html with React app
/todos - static server returns index.html with React app
/api/todos - server handles any /api/* requests using the backend implementation
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.
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:
"proxy" : "http://localhost:4000" ,
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 text/html
in its Accept
header to the proxy.
Conveniently, this avoids CORS issues and error messages like this in development:
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.
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
.
The proxy
option supports HTTP, HTTPS and WebSocket connections.
If the proxy
option is not flexible enough for you, alternatively you can:
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 and this issue.
This shouldn't affect you when developing on localhost
, but if you develop remotely like described here, you will see this error in the browser after enabling the proxy
option:
Invalid Host header
To work around it, you can specify your public development host in a file called .env.development
in the root of your project:
HOST=mypublicdevhost.com
If you restart the development server now and load the app from the specified host, it should work.
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:
# NOTE: THIS IS DANGEROUS!
# It exposes your machine to attacks from the websites you visit.
DANGEROUSLY_DISABLE_HOST_CHECK=true
We don't recommend this approach.
Note: this feature is available with
[email protected]
and higher.
If the proxy
option is not flexible enough for you, you can get direct access to the Express app instance and hook up your own proxy middleware.
You can use this feature in conjunction with the proxy
property in package.json
, but it is recommended you consolidate all of your logic into src/setupProxy.js
.
First, install http-proxy-middleware
using npm or Yarn:
$ npm install http-proxy-middleware --save
$ # or
$ yarn add http-proxy-middleware
Next, create src/setupProxy.js
and place the following contents in it:
const proxy = require ( 'http-proxy-middleware' ) ;
module . exports = function ( app ) {
// ...
} ;
You can now register proxies as you wish! Here's an example using the above http-proxy-middleware
:
const proxy = require ( 'http-proxy-middleware' ) ;
module . exports = function ( app ) {
app . use ( proxy ( '/api' , { target : 'http://localhost:5000/' } ) ) ;
} ;
Note: You do not need to import this file anywhere. It is automatically registered when you start the development server.
Note: This file only supports Node's JavaScript syntax. Be sure to only use supported language features (ie no support for Flow, ES Modules, etc).
Note: Passing the path to the proxy function allows you to use globbing and/or pattern matching on the path, which is more flexible than the express route matching.
Note: this feature is available with
[email protected]
and higher.
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 to proxy requests to an API server when that API server is itself serving HTTPS.
To do this, set the HTTPS
environment variable to true
, then start the dev server as usual with npm start
:
set HTTPS = true && npm start
(Note: the lack of whitespace is intentional.)
( $ env: HTTPS = $true ) -and (npm start)
HTTPS=true npm start
Note that the server will use a self-signed certificate, so your web browser will almost definitely display a warning upon accessing the page.
<meta>
Tags on the Server 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:
<!doctype html >
< html lang =" en " >
< head >
< meta property =" og:title " content =" __OG_TITLE__ " >
< meta property =" og:description " content =" __OG_DESCRIPTION__ " >
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!
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.
If you're hosting your build
with a static hosting provider you can use react-snapshot or react-snap 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.
There are also opportunities to use this outside of static hosting, to take the pressure off the server when generating and caching routes.
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.
You can read more about zero-configuration pre-rendering (also called snapshotting) here.
Similarly to the previous section, you can leave some placeholders in the HTML that inject global variables, for example:
< ! doctype html >
< html lang = "en" >
< head >
< script >
window.SERVER_DATA = __SERVER_DATA__;
< / script >
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 as it makes your app vulnerable to XSS attacks.
Note: this feature is available with
[email protected]
and higher.
Read the migration guide to learn how to enable it in older projects!
Create React App uses Jest as its test runner. To prepare for this integration, we did a major revamp of Jest so if you heard bad things about it years ago, give it another try.
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.
While Jest provides browser globals such as window
thanks to 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.
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.
Jest will look for test files with any of the following popular naming conventions:
.js
suffix in __tests__
folders..test.js
suffix..spec.js
suffix. The .test.js
/ .spec.js
files (or the __tests__
folders) can be located at any depth under the src
top level folder.
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.
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.
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:
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.
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.
Jest will always run all tests on a continuous integration server or if the project is not inside a Git or Mercurial repository.
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.
Jest provides a built-in expect()
global function for making assertions. A basic test could look like this:
import sum from './sum' ;
it ( 'sums numbers' , ( ) => {
expect ( sum ( 1 , 2 ) ) . toEqual ( 3 ) ;
expect ( sum ( 2 , 2 ) ) . toEqual ( 4 ) ;
} ) ;
All expect()
matchers supported by Jest are extensively documented here.
You can also use jest.fn()
and expect(fn).toBeCalled()
to create “spies” or mock functions.
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.
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:
import React from 'react' ;
import ReactDOM from 'react-dom' ;
import App from './App' ;
it ( 'renders without crashing' , ( ) => {
const div = document . createElement ( 'div' ) ;
ReactDOM . render ( < App / > , div ) ;
} ) ;
This test mounts a component and makes sure that it didn't throw during rendering. Tests like this provide a lot of 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
.
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.
If you'd like to test components in isolation from the child components they render, we recommend using shallow()
rendering API from Enzyme. To install it, run:
npm install --save enzyme enzyme-adapter-react-16 react-test-renderer
Alternatively you may use yarn
:
yarn add enzyme enzyme-adapter-react-16 react-test-renderer
As of Enzyme 3, you will need to install Enzyme along with an Adapter corresponding to the version of React you are using. (The examples above use the adapter for React 16.)
The adapter will also need to be configured in your global setup file:
src/setupTests.js
import { configure } from 'enzyme' ;
import Adapter from 'enzyme-adapter-react-16' ;
configure ( { adapter : new Adapter ( ) } ) ;
Note: Keep in mind that if you decide to "eject" before creating
src/setupTests.js
, the resultingpackage.json
file won't contain any reference to it. Read here to learn how to add this after ejecting.
Now you can write a smoke test with it:
import React from 'react' ;
import { shallow } from 'enzyme' ;
import App from './App' ;
it ( 'renders without crashing' , ( ) => {
shallow ( < App / > ) ;
} ) ;
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()
, and you can also use it for testing state changes and component lifecycle.
You can read the Enzyme documentation 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.
Here is an example from Enzyme documentation that asserts specific output, rewritten to use Jest matchers:
import React from 'react' ;
import { shallow } from 'enzyme' ;
import App from './App' ;
it ( 'renders welcome message' , ( ) => {
const wrapper = shallow ( < App / > ) ;
const welcome = < h2 > Welcome to React < / h2 > ;
// expect(wrapper.contains(welcome)).toBe(true);
expect ( wrapper . contains ( welcome ) ) . toEqual ( true ) ;
} ) ;
All Jest matchers are extensively documented here.
Nevertheless you can use a third-party assertion library like Chai if you want to, as described below.
Additionally, you might find jest-enzyme helpful to simplify your tests with readable matchers. The above contains
code can be written more simply with jest-enzyme.
expect ( wrapper ) . toContainReact ( welcome ) ;
To enable this, install jest-enzyme
:
npm install --save jest-enzyme
Alternatively you may use yarn
:
yarn add jest-enzyme
Import it in src/setupTests.js
to make its matchers available in every test:
import 'jest-enzyme' ;
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, and we'll fix them. We intend to keep making them better for React, supporting, for example, pretty-printing React elements as JSX.
However, if you are used to other libraries, such as Chai and Sinon, or if you have existing code using them that you'd like to port over, you can import them normally like this:
import sinon from 'sinon' ;
import { expect } from 'chai' ;
and then use them in your tests like you normally do.
Note: this feature is available with
[email protected]
and higher.
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.
Por exemplo:
src/setupTests.js
const localStorageMock = {
getItem : jest . fn ( ) ,
setItem : jest . fn ( ) ,
clear : jest . fn ( ) ,
} ;
global . localStorage = localStorageMock ;
Note: Keep in mind that if you decide to "eject" before creating
src/setupTests.js
, the resultingpackage.json
file won't contain any reference to it, so you should manually create the propertysetupTestFrameworkScriptFile
in the configuration for Jest, something like the following:
"jest" : { // ... "setupTestFrameworkScriptFile" : "<rootDir>/src/setupTests.js" }
You can replace it()
with xit()
to temporarily exclude a test from being executed.
Similarly, fit()
lets you focus on a specific test without running any other tests.
Jest has an integrated coverage reporter that works well with ES6 and requires no configuration.
Run npm test -- --coverage
(note extra --
in the middle) to include a coverage report like this:
Note that tests run much slower with coverage so it is recommended to run it separately from your normal workflow.
The default Jest coverage configuration can be overridden by adding any of the following supported keys to a Jest config in your package.json.
Supported overrides:
collectCoverageFrom
coverageReporters
coverageThreshold
snapshotSerializers
Example package.json:
{
"name" : " your-package " ,
"jest" : {
"collectCoverageFrom" : [
" src/**/*.{js,jsx} " ,
" !<rootDir>/node_modules/ " ,
" !<rootDir>/path/to/dir/ "
],
"coverageThreshold" : {
"global" : {
"branches" : 90 ,
"functions" : 90 ,
"lines" : 90 ,
"statements" : 90
}
},
"coverageReporters" : [ " text " ],
"snapshotSerializers" : [ " my-serializer-module " ]
}
}
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
.
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.
Popular CI servers already set the environment variable CI
by default but you can do this yourself too:
.travis.yml
file to your git repository. language: node_js
node_js:
- 8
cache:
directories:
- node_modules
script:
- npm run build
- npm test
Follow this article to set up CircleCI with a Create React App project.
set CI = true && npm test
set CI = true && npm run build
(Note: the lack of whitespace is intentional.)
( $ env: CI = $true ) -and (npm test)
( $ env: CI = $true ) -and (npm run build)
CI=true npm test
CI=true npm run build
The test command will force Jest to run tests once instead of launching the watcher.
If you find yourself doing this often in development, please file an issue 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.
The build command will check for linter warnings and fail if any are found.
If you know that none of your tests depend on jsdom, you can safely set --env=node
, and your tests will run faster:
"scripts": {
"start": "react-scripts start",
"build": "react-scripts build",
- "test": "react-scripts test"
+ "test": "react-scripts test --env=node"
To help you make up your mind, here is a list of APIs that need jsdom :
window
and document
ReactDOM.render()
TestUtils.renderIntoDocument()
(a shortcut for the above)mount()
in EnzymeIn contrast, jsdom is not needed for the following APIs:
TestUtils.createRenderer()
(shallow rendering)shallow()
in EnzymeFinally, jsdom is also not needed for snapshot testing.
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.
If you use Visual Studio Code, there is a Jest extension 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.
There are various ways to setup a debugger for your Jest tests. We cover debugging in Chrome and Visual Studio Code.
Note: debugging tests requires Node 8 or higher.
Add the following to the scripts
section in your project's package.json
"scripts" : {
"test:debug" : " react-scripts --inspect-brk test --runInBand "
}
Place debugger;
statements in any test and run:
$ npm run test:debug
This will start running your Jest tests, but pause before executing to allow a debugger to attach to the process.
Open the following in Chrome
about:inspect
After opening that link, the Chrome Developer Tools will be displayed. Select inspect
on your process and a breakpoint will be set at the first line of the react script (this is done simply to give you time to open the developer tools and to prevent Jest from executing before you have time to do so). Click the button that looks like a "play" button in the upper right hand side of the screen to continue execution. When Jest executes the test that contains the debugger statement, execution will pause and you can examine the current scope and call stack.
Note: the --runInBand cli option makes sure Jest runs test in the same process rather than spawning processes for individual tests. Normally Jest parallelizes test runs across processes but it is hard to debug many processes at the same time.
Debugging Jest tests is supported out of the box for Visual Studio Code.
Use the following launch.json
configuration file:
{
"version": "0.2.0",
"configurations": [
{
"name": "Debug CRA Tests",
"type": "node",
"request": "launch",
"runtimeExecutable": "${workspaceRoot}/node_modules/.bin/react-scripts",
"args": [
"test",
"--runInBand",
"--no-cache"
],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"console": "integratedTerminal",
"internalConsoleOptions": "neverOpen"
}
]
}
Usually, in an app, you have a lot of UI components, and each of them has many different states. For an example, a simple button component could have following states:
Usually, it's hard to see these states without running a sample app or some examples.
Create React App doesn't include any tools for this by default, but you can easily add Storybook for React (source) or React Styleguidist (source) to your project. These are third-party tools that let you develop components and see all their states in isolation from your app .
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.
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.
First, install the following npm package globally:
npm install -g @storybook/cli
Then, run the following command inside your app's directory:
getstorybook
After that, follow the instructions on the screen.
Learn more about React Storybook:
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.
First, install Styleguidist:
npm install --save react-styleguidist
Alternatively you may use yarn
:
yarn add react-styleguidist
Then, add these scripts to your package.json
:
"scripts": {
+ "styleguide": "styleguidist server",
+ "styleguide:build": "styleguidist build",
"start": "react-scripts start",
Then, run the following command inside your app's directory:
npm run styleguide
After that, follow the instructions on the screen.
Learn more about React Styleguidist:
Create React App doesn't provide any built-in functionality to publish a component to npm. If you're ready to extract a component from your project so other people can use it, we recommend moving it to a separate directory outside of your project and then using a tool like nwb to prepare it for publishing.
The production build has all the tools necessary to generate a first-class Progressive Web App, but the offline/cache-first behavior is opt-in only . By default, the build process will generate a service worker file, but it will not be registered, so it will not take control of your production web app.
In order to opt-in to the offline-first behavior, developers should look for the following in their src/index.js
file:
// If you want your app to work offline and load faster, you can change
// unregister() to register() below. Note this comes with some pitfalls.
// Learn more about service workers: http://bit.ly/CRA-PWA
serviceWorker . unregister ( ) ;
As the comment states, switching serviceWorker.unregister()
to serviceWorker.register()
will opt you in to using the service worker.
Offline-first Progressive Web Apps are faster and more reliable than traditional web pages, and provide an engaging mobile experience:
However, they can make debugging deployments more challenging so, starting with Create React App 2, service workers are opt-in.
The workbox-webpack-plugin
is integrated into production configuration, and it will take care of generating a service worker file that will automatically precache all of your local assets and keep them up to date as you deploy updates. The service worker will use a cache-first strategy for handling all requests for local assets, including navigation requests for your HTML, ensuring that your web app is consistently fast, even on a slow or unreliable network.
If you do decide to opt-in to service worker registration, please take the following into account:
Service workers require HTTPS, although to facilitate local testing, that policy does not apply to localhost
. If your production web server does not support HTTPS, then the service worker registration will fail, but the rest of your web app will remain functional.
Service workers are not supported in older web browsers. Service worker registration won't be attempted on browsers that lack support.
The service worker is only enabled in the production environment, eg the output of npm run build
. It's recommended that you do not enable an offline-first service worker in a development environment, as it can lead to frustration when previously cached assets are used and do not include the latest changes you've made locally.
If you need to test your offline-first service worker locally, build the application (using npm run build
) and run a simple http server from your build directory. After running the build script, create-react-app
will give instructions for one way to test your production build locally and the deployment instructions have instructions for using other methods. Be sure to always use an incognito window to avoid complications with your browser cache.
Users aren't always familiar with offline-first web apps. It can be useful to let the user know when the service worker has finished populating your caches (showing a "This web app works offline!" message) and also let them know when the service worker has fetched the latest updates that will be available the next time they load the page (showing a "New content is available; please refresh." message). Showing this messages is currently left as an exercise to the developer, but as a starting point, you can make use of the logic included in src/registerServiceWorker.js
, which demonstrates which service worker lifecycle events to listen for to detect each scenario, and which as a default, just logs appropriate messages to the JavaScript console.
By default, the generated service worker file will not intercept or cache any cross-origin traffic, like HTTP API requests, images, or embeds loaded from a different domain.
The default configuration includes a web app manifest located at public/manifest.json
, that you can customize with details specific to your web application.
When a user adds a web app to their homescreen using Chrome or Firefox on Android, the metadata in manifest.json
determines what icons, names, and branding colors to use when the web app is displayed. The Web App Manifest guide provides more context about what each field means, and how your customizations will affect your users' experience.
Progressive web apps that have been added to the homescreen will load faster and work offline when there's an active service worker. That being said, the metadata from the web app manifest will still be used regardless of whether or not you opt-in to service worker registration.
Source map explorer analyzes JavaScript bundles using the source maps. This helps you understand where code bloat is coming from.
To add Source map explorer to a Create React App project, follow these steps:
npm install --save source-map-explorer
Alternatively you may use yarn
:
yarn add source-map-explorer
Then in package.json
, add the following line to scripts
:
"scripts": {
+ "analyze": "source-map-explorer build/static/js/main.*",
"start": "react-scripts start",
"build": "react-scripts build",
"test": "react-scripts test",
Then to analyze the bundle run the production build then run the analyze script.
npm run build
npm run analyze
npm run build
creates a build
directory with a production build of your app. Set up your favorite 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.
For environments using Node, the easiest way to handle this would be to install serve and let it handle the rest:
npm install -g serve
serve -s build
The last command shown above will serve your static site on the port 5000 . Like many of serve's internal settings, the port can be adjusted using the -p
or --port
flags.
Run this command to get a full list of the options available:
serve -h
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.
Here's a programmatic example using Node and Express:
const express = require ( 'express' ) ;
const path = require ( 'path' ) ;
const app = express ( ) ;
app . use ( express . static ( path . join ( __dirname , 'build' ) ) ) ;
app . get ( '/' , function ( req , res ) {
res . sendFile ( path . join ( __dirname , 'build' , 'index.html' ) ) ;
} ) ;
app . listen ( 9000 ) ;
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.
The build
folder with static assets is the only output produced by Create React App.
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.
If you use routers that use the HTML5 pushState
history API under the hood (for example, 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.
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:
app.use(express.static(path.join(__dirname, 'build')));
- app.get('/', function (req, res) {
+ app.get('/*', function (req, res) {
res.sendFile(path.join(__dirname, 'build', 'index.html'));
});
If you're using Apache HTTP Server, you need to create a .htaccess
file in the public
folder that looks like this:
Options -MultiViews
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^ index.html [QSA,L]
It will get copied to the build
folder when you run npm run build
.
If you're using Apache Tomcat, you need to follow this Stack Overflow answer.
Now requests to /todos/42
will be handled correctly both in development and in production.
On a production build, and when you've opted-in, a service worker will automatically handle all navigation requests, like for /todos/42
, by serving the cached copy of your index.html
. This service worker navigation routing can be configured or disabled by eject
ing and then modifying the navigateFallback
and navigateFallbackWhitelist
options of the SWPreachePlugin
configuration.
When users install your app to the homescreen of their device the default configuration will make a shortcut to /index.html
. This may not work for client-side routers which expect the app to be served from /
. Edit the web app manifest at public/manifest.json
and change start_url
to match the required URL scheme, for example:
"start_url" : "." ,
By default, Create React App produces a build assuming your app is hosted at the server root.
To override this, specify the homepage
in your package.json
, for example:
"homepage" : "http://mywebsite.com/relativepath" ,
This will let Create React App correctly infer the root path to use in the generated HTML file.
Note : If you are using react-router@^4
, you can root <Link>
s using the basename
prop on any <Router>
.
More information here.
Por exemplo:
< BrowserRouter basename = "/calendar" / >
< Link to = "/today" / > // renders <a href="/calendar/today">
Note: this feature is available with
[email protected]
and higher.
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
:
"homepage" : "." ,
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.
You can create an arbitrary build environment by creating a custom .env
file and loading it using env-cmd.
For example, to create a build environment for a staging environment:
.env.staging
.env
file (eg REACT_APP_API_URL=http://api-staging.example.com
)$ npm install env-cmd --save
$ # or
$ yarn add env-cmd
package.json
, building with your new environment: {
"scripts" : {
"build:staging" : " env-cmd .env.staging npm run build "
}
}
Now you can run npm run build:staging
to build with the staging environment config. You can specify other environments in the same way.
Variables in .env.production
will be used as fallback because NODE_ENV
will always be set to production
for a build.
See this blog post on how to deploy your React app to Microsoft Azure.
See this blog post or this repo for a way to use automatic deployment to Azure App Service.
Install the Firebase CLI if you haven't already by running npm install -g firebase-tools
. Sign up for a Firebase account and create a new project. Run firebase login
and login with your previous created Firebase account.
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
.
=== Project Setup
First, let ' s associate this project directory with a Firebase project.
You can create multiple project aliases by running firebase use --add,
but for now we ' ll just set up a default project.
? What Firebase project do you want to associate as default ? Example app (example-app-fd690)
=== Database Setup
Firebase Realtime Database Rules allow you to define how your data should be
structured and when your data can be read from and written to.
? What file should be used for Database Rules ? database.rules.json
✔ Database Rules for example-app-fd690 have been downloaded to database.rules.json.
Future modifications to database.rules.json will update Database Rules when you run
firebase deploy.
=== Hosting Setup
Your public directory is the folder (relative to your project directory) that
will contain Hosting assets to uploaded with firebase deploy. If you
have a build process for your assets, use your build ' s output directory.
? What do you want to use as your public directory? build
? Configure as a single-page app (rewrite all urls to /index.html)? Yes
✔ Wrote build/index.html
i Writing configuration info to firebase.json...
i Writing project information to .firebaserc...
✔ Firebase initialization complete!
IMPORTANT: you need to set proper HTTP caching headers for service-worker.js
file in firebase.json
file or you will not be able to see changes after first deployment (issue #2440). It should be added inside "hosting"
key like next:
{
"hosting": {
...
"headers": [
{"source": "/service-worker.js", "headers": [{"key": "Cache-Control", "value": "no-cache"}]}
]
...
Now, after you create a production build with npm run build
, you can deploy it by running firebase deploy
.
=== Deploying to ' example-app-fd690 ' ...
i deploying database, hosting
✔ database: rules ready to deploy.
i hosting: preparing build directory for upload...
Uploading: [ ============================== ] 75%✔ hosting: build folder uploaded successfully
✔ hosting: 8 files uploaded successfully
i starting release process (may take several minutes)...
✔ Deploy complete !
Project Console: https://console.firebase.google.com/project/example-app-fd690/overview
Hosting URL: https://example-app-fd690.firebaseapp.com
For more information see Add Firebase to your JavaScript Project.
Note: this feature is available with
[email protected]
and higher.
homepage
to package.json
The step below is important!
If you skip it, your app will not deploy correctly.
Open your package.json
and add a homepage
field for your project:
"homepage" : " https://myusername.github.io/my-app " ,
or for a GitHub user page:
"homepage" : " https://myusername.github.io " ,
or for a custom domain page:
"homepage" : " https://mywebsite.com " ,
Create React App uses the homepage
field to determine the root URL in the built HTML file.
gh-pages
and add deploy
to scripts
in package.json
Now, whenever you run npm run build
, you will see a cheat sheet with instructions on how to deploy to GitHub Pages.
To publish it at https://myusername.github.io/my-app, run:
npm install --save gh-pages
Alternatively you may use yarn
:
yarn add gh-pages
Add the following scripts in your package.json
:
"scripts": {
+ "predeploy": "npm run build",
+ "deploy": "gh-pages -d build",
"start": "react-scripts start",
"build": "react-scripts build",
The predeploy
script will run automatically before deploy
is run.
If you are deploying to a GitHub user page instead of a project page you'll need to make two additional modifications:
package.json
scripts to push deployments to master : "scripts": {
"predeploy": "npm run build",
- "deploy": "gh-pages -d build",
+ "deploy": "gh-pages -b master -d build",
npm run deploy
Em seguida, corra:
npm run deploy
gh-pages
Finally, make sure GitHub Pages option in your GitHub project settings is set to use the gh-pages
branch:
You can configure a custom domain with GitHub Pages by adding a CNAME
file to the public/
folder.
Your CNAME file should look like this:
mywebsite.com
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:
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 about different history implementations in React Router.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. If, when deploying, you get /dev/tty: No such a device or address
or a similar error, try the following:
git remote set-url origin https://<user>:<token>@github.com/<user>/<repo>
.npm run deploy
again If, when deploying, you get Cannot read property 'email' of null
, try the following:
git config --global user.name '<your_name>'
git config --global user.email '<your_email>'
npm run deploy
again Use the Heroku Buildpack for Create React App.
You can find instructions in Deploying React with Zero Configuration.
Sometimes npm run build
works locally but fails during deploy via Heroku. Following are the most common cases.
If you get something like this:
remote: Failed to create a production build. Reason:
remote: Module not found: Error: Cannot resolve 'file' or 'directory'
MyDirectory in /tmp/build_1234/src
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.
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.
If you exclude or ignore necessary files from the package you will see a error similar this one:
remote: Could not find a required file.
remote: Name: `index.html`
remote: Searched in: /tmp/build_a2875fc163b209225122d68916f1d4df/public
remote:
remote: npm ERR! Linux 3.13.0-105-generic
remote: npm ERR! argv "/tmp/build_a2875fc163b209225122d68916f1d4df/.heroku/node/bin/node" "/tmp/build_a2875fc163b209225122d68916f1d4df/.heroku/node/bin/npm" "run" "build"
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
.
To do a manual deploy to Netlify's CDN:
npm install netlify-cli -g
netlify deploy
Choose build
as the path to deploy.
To setup continuous delivery:
With this setup Netlify will build and deploy when you push to git or open a pull request:
Build your site
Support for client-side routing:
To support pushState
, make sure to create a public/_redirects
file with the following rewrite rules:
/* /index.html 200
When you build the project, Create React App will place the public
folder contents into the build output.
Now offers a zero-configuration single-command deployment. You can use now
to deploy your app for free.
Install the now
command-line tool either via the recommended desktop tool or via node with npm install -g now
.
Build your app by running npm run build
.
Move into the build directory by running cd build
.
Run now --name your-project-name
from within the build directory. You will see a now.sh URL in your output like this:
> Ready! https://your-project-name-tpspyhtdtk.now.sh (copied to clipboard)
Paste that URL into your browser when the build is complete, and you will see your deployed app.
Details are available in this article.
See this blog post on how to deploy your React app to Amazon Web Services S3 and CloudFront.
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.
When asked about the project path, make sure to specify the build
folder, for example:
project path: /path/to/project/build
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.
You can adjust various development and production settings by setting environment variables in your shell or with .env.
Variável | Desenvolvimento | Produção | Uso |
---|---|---|---|
NAVEGADOR | ✅ | By default, Create React App will open the default system browser, favoring Chrome on macOS. Specify a browser 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. | |
HOSPEDAR | ✅ | By default, the development web server binds to localhost . You may use this variable to specify a different host. | |
PORTA | ✅ | 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. | |
HTTPS | ✅ | When set to true , Create React App will run the development server in https mode. | |
PUBLIC_URL | ✅ | Create React App assumes your application is hosted at the serving web server's root or a subpath as specified in package.json ( homepage ). 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. | |
CI | ? | ✅ | 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. |
REACT_EDITOR | ✅ | 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. Setting this environment variable overrides the automatic detection. If you do it, make sure your systems PATH environment variable points to your editor's bin folder. You can also set it to none to disable it completely. | |
CHOKIDAR_USEPOLLING | ✅ | 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. | |
GENERATE_SOURCEMAP | ✅ | When set to false , source maps are not generated for a production build. This solves OOM issues on some smaller machines. | |
NODE_PATH | ✅ | ✅ | Same as NODE_PATH in Node.js, but only relative folders are allowed. Can be handy for emulating a monorepo setup by setting NODE_PATH=src . |
npm start
doesn't detect changes When you save a file while npm start
is running, the browser should refresh with the updated code.
If this doesn't happen, try one of the following workarounds:
index.js
and you're referencing it by the folder name, you need to restart the watcher due to a Webpack bug..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.If none of these solutions help please leave a comment in this thread.
npm test
hangs or crashes on macOS Sierra If you run npm test
and the console gets stuck after printing react-scripts test
to the console there might be a problem with your Watchman installation as described in facebook/create-react-app#713.
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:
It is reported that installing Watchman 4.7.0 or newer fixes the issue. If you use Homebrew, you can run these commands to update it:
watchman shutdown-server
brew update
brew reinstall watchman
You can find other installation methods on the Watchman documentation page.
If this still doesn't help, try running launchctl unload -F ~/Library/LaunchAgents/com.github.facebook.watchman.plist
.
There are also reports that uninstalling Watchman fixes the issue. So if nothing else helps, remove it from your system and try again.
npm run build
exits too early 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:
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.
If you are completely sure that you didn't terminate the process, consider adding some swap space to the machine you're building on, or build the project locally.
npm run build
fails on HerokuThis may be a problem with case sensitive filenames. Please refer to this section.
If you use a Moment.js, 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.
To add a specific Moment.js locale to your bundle, you need to import it explicitly.
Por exemplo:
import moment from 'moment' ;
import 'moment/locale/fr' ;
If you are importing multiple locales this way, you can later switch between them by calling moment.locale()
with the locale name:
import moment from 'moment' ;
import 'moment/locale/fr' ;
import 'moment/locale/es' ;
// ...
moment . locale ( 'fr' ) ;
This will only work for locales that have been explicitly imported before.
npm run build
fails to minify Before [email protected]
, this problem was caused by third party node_modules
using modern JavaScript features because the minifier couldn't handle them during the build. This has been solved by compiling standard modern JavaScript features inside node_modules
in [email protected]
and higher.
If you're seeing this error, you're likely using an old version of react-scripts
. You can either fix it by avoiding a dependency that uses modern syntax, or by upgrading to react-scripts@>=2.0.0
and following the migration instructions in the changelog.
Ejecting lets you customize anything, but from that point on you have to maintain the configuration and scripts yourself. This can be daunting if you have many similar projects. In such cases instead of ejecting we recommend to fork react-scripts
and any other packages you need. This article dives into how to do it in depth. You can find more discussion in this issue.
If you have ideas for more “How To” recipes that should be on this page, let us know or contribute some!