kinokong
1.0.0
Este proyecto fue arrancado con la aplicación Create React.
A continuación encontrará información sobre cómo realizar tareas comunes.
Puede encontrar la versión más reciente de esta guía aquí.
<title> >publicpublic.env<meta> en el servidornpm start no detecta cambiosnpm test cuelga o se bloquea en MacOS Sierranpm run build sale demasiado tempranonpm run build fallas en Herokunpm run build no puede minificarCrear aplicación React se divide en dos paquetes:
create-react-app es una utilidad de línea de comandos global que utiliza para crear nuevos proyectos.react-scripts es una dependencia del desarrollo en los proyectos generados (incluidos este). Casi nunca necesita actualizar create-react-app en sí: delega toda la configuración a react-scripts .
Cuando ejecuta create-react-app , siempre crea el proyecto con la última versión de react-scripts , por lo que obtendrá todas las nuevas funciones y mejoras en las aplicaciones recién creadas automáticamente.
Para actualizar un proyecto existente a una nueva versión de react-scripts , abra el ChangeLog, busque la versión en la que se encuentra actualmente (verifique package.json en esta carpeta si no está seguro) y aplique las instrucciones de migración para el nuevo versiones.
En la mayoría de los casos, aumentar la versión react-scripts en package.json y ejecutar npm install (o yarn install ) en esta carpeta debería ser suficiente, pero es bueno consultar el ChangeLog para posibles cambios de ruptura.
Nos comprometemos a mantener los cambios de ruptura mínimos para que pueda actualizar react-scripts sin dolor.
Siempre estamos abiertos a sus comentarios.
Después de la creación, su proyecto debería verse así:
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 el proyecto se construya, estos archivos deben existir con nombres de archivo exactos :
public/index.html es la plantilla de página;src/index.js es el punto de entrada de JavaScript.Puede eliminar o cambiar el nombre de los otros archivos.
Puede crear subdirectorios dentro de src . Para reconstrucciones más rápidas, solo SRC se procesan los archivos dentro de src .
Debe colocar cualquier archivo JS y CSS dentro de src , de lo contrario Webpack no los verá.
Solo los archivos dentro public se pueden usar desde public/index.html .
Lea las instrucciones a continuación para usar activos de JavaScript y HTML.
Sin embargo, puede crear más directorios de nivel superior.
No se incluirán en la construcción de producción para que pueda usarlos para cosas como la documentación.
En el directorio del proyecto, puede ejecutar:
npm start Ejecuta la aplicación en el modo de desarrollo.
Abra http: // localhost: 3000 para verlo en el navegador.
La página se volverá a cargar si realiza ediciones.
También verá errores de linta en la consola.
npm test Inicia el corredor de prueba en el modo de reloj interactivo.
Consulte la sección sobre las pruebas de ejecución para obtener más información.
npm run build Construye la aplicación para la producción a la carpeta build .
Se reacciona correctamente en modo de producción y optimiza la compilación para el mejor rendimiento.
La construcción se minifica y los nombres de archivo incluyen los hashes.
¡Su aplicación está lista para ser implementada!
Consulte la sección sobre implementación para obtener más información.
npm run eject Nota: Esta es una operación unidireccional. Una vez que te eject , ¡no puedes volver!
Si no está satisfecho con la herramienta de compilación y las opciones de configuración, puede eject en cualquier momento. Este comando eliminará la dependencia de la compilación única de su proyecto.
En su lugar, copiará todos los archivos de configuración y las dependencias transitivas (Webpack, Babel, Eslint, etc.) directamente en su proyecto para que tenga el control total sobre ellas. Todos los comandos, excepto eject seguirán funcionando, pero señalarán los scripts copiados para que pueda ajustarlos. En este punto, estás solo.
No tienes que usar eject . El conjunto de características curadas es adecuada para implementaciones pequeñas y medias, y no debe sentirse obligado a usar esta función. Sin embargo, entendemos que esta herramienta no sería útil si no pudiera personalizarla cuando esté listo para ello.
Por defecto, el proyecto generado admite todos los navegadores modernos.
Soporte para Internet Explorer 9, 10 y 11 requiere polyultos.
Este proyecto admite un superceptor del último estándar de JavaScript.
Además de las funciones de sintaxis ES6, también es compatible:
Obtenga más información sobre diferentes etapas de propuestas.
Si bien recomendamos usar propuestas experimentales con cierta precaución, Facebook usa en gran medida estas características en el código de producto, por lo que tenemos la intención de proporcionar CodeMods si alguna de estas propuestas cambia en el futuro.
Tenga en cuenta que este proyecto no incluye polyfills de forma predeterminada.
Si usa alguna otra característica de ES6+ que necesitan soporte de tiempo de ejecución (como Array.from() o Symbol ), asegúrese de incluir los polyfills apropiados manualmente, o que los navegadores a los que se dirige ya los admite.
Para configurar el resaltado de sintaxis en su editor de texto favorito, diríjase a la página de documentación de Babel relevante y siga las instrucciones. Algunos de los editores más populares están cubiertos.
Nota: Esta característica está disponible con
[email protected]y superior.
También solo funciona con NPM 3 o superior.
Algunos editores, incluidos el texto sublime, Atom y Visual Studio Code, proporcionan complementos para Eslint.
No son necesarios para la pelusa. Debería ver la salida del enlace directamente en su terminal, así como en la consola del navegador. Sin embargo, si prefiere que los resultados de la pelusa aparezcan bien en su editor, hay algunos pasos adicionales que puede hacer.
Primero necesitaría instalar un complemento de Eslint para su editor. Luego, agregue un archivo llamado .eslintrc a la raíz del proyecto:
{
"extends" : "react-app"
}Ahora su editor debe informar las advertencias de pelusa.
Tenga en cuenta que incluso si edita aún más su archivo .eslintrc , estos cambios solo afectarán la integración del editor . No afectarán la salida de la pelusa terminal y en el navegador. Esto se debe a que Crear aplicación React intencionalmente proporciona un conjunto mínimo de reglas que encuentran errores comunes.
Si desea hacer cumplir un estilo de codificación para su proyecto, considere usar las reglas de estilo de Eslint.
Actualmente, esta característica solo es compatible con Visual Studio Code y Webstorm.
Visual Studio Code y Webstorm admiten depuración de la caja con la aplicación Crear React. Esto le permite como desarrollador escribir y depurar su código React sin dejar el editor, y lo más importante es que le permite tener un flujo de trabajo de desarrollo continuo, donde el cambio de contexto es mínimo, ya que no tiene que cambiar entre herramientas.
Debería tener la última versión de VS Code y VS Code Chrome Debugger Extension instalada.
Luego, agregue el bloque a continuación a su archivo launch.json y colóquelo dentro de la carpeta .vscode en el directorio raíz de su aplicación.
{
"version" : " 0.2.0 " ,
"configurations" : [
{
"name" : " Chrome " ,
"type" : " chrome " ,
"request" : " launch " ,
"url" : " http://localhost:3000 " ,
"webRoot" : " ${workspaceRoot}/src " ,
"sourceMapPathOverrides" : {
"webpack:///src/*" : " ${webRoot}/* "
}
}
]
}Nota: La URL puede ser diferente si ha realizado ajustes a través de las variables de entorno host o puerto.
Inicie su aplicación ejecutando npm start y comience a depurar en el código VS presionando F5 o haciendo clic en el icono de depuración verde. Ahora puede escribir código, establecer puntos de interrupción, realizar cambios en el código y depurar su código recién modificado, todo de su editor.
¿Tiene problemas con la depuración del código VS? Consulte su guía de solución de problemas.
Necesitaría tener instalados Webstorm y JetBrains IDE Support Chrome Extension.
En el menú WebStorm Run Seleccione Edit Configurations... Luego haga clic en + y seleccione JavaScript Debug . Peque http://localhost:3000 en el campo URL y guarde la configuración.
Nota: La URL puede ser diferente si ha realizado ajustes a través de las variables de entorno host o puerto.
Inicie su aplicación ejecutando npm start , luego presione ^D en macOS o F9 en Windows y Linux o haga clic en el icono de depuración verde para comenzar a depurar en Webstorm.
De la misma manera que puede depurar su aplicación en IntelliJ Idea Ultimate, PhpStorm, Pycharm Pro y Rubymine.
Prettier es un formateador de código obstinado con soporte para JavaScript, CSS y JSON. Con Prettier puede formatear el código que escribe automáticamente para garantizar un estilo de código dentro de su proyecto. Consulte la página GitHub de Prettier para obtener más información y mire esta página para verla en acción.
Para formatear nuestro código siempre que nos comprometamos en GIT, necesitamos instalar las siguientes dependencias:
npm install --save husky lint-staged prettier Alternativamente, puede usar yarn :
yarn add husky lint-staged prettierhusky facilita el uso de Githooks como si fueran scripts NPM.lint-staged nos permite ejecutar scripts en archivos escenificados en GIT. Vea esta publicación de blog sobre pelusa para obtener más información al respecto.prettier es el formateador de JavaScript que ejecutaremos antes de cometer. Ahora podemos asegurarnos de que cada archivo esté formateado correctamente agregando algunas líneas al package.json en la raíz del proyecto.
Agregue el siguiente campo a la sección package.json :
+ "husky": {
+ "hooks": {
+ "pre-commit": "lint-staged"
+ }
+ } A continuación, agregamos un campo de 'pelusa' al package.json , por ejemplo:
"dependencies": {
// ...
},
+ "lint-staged": {
+ "src/**/*.{js,jsx,json,css}": [
+ "prettier --single-quote --write",
+ "git add"
+ ]
+ },
"scripts": { Ahora, cada vez que se comprometa, más bonito formateará los archivos cambiados automáticamente. También puede ejecutar ./node_modules/.bin/prettier --single-quote --write "src/**/*.{js,jsx}" para formatear todo su proyecto por primera vez.
A continuación, es posible que desee integrar más bonito en su editor favorito. Lea la sección sobre Integración del editor en la página GitHub más bonita.
<title> > Puede encontrar el archivo HTML de origen en la carpeta public del proyecto generado. Puede editar la etiqueta <title> en ella para cambiar el título de "React App" a cualquier otra cosa.
Tenga en cuenta que normalmente no editaría archivos en la carpeta public muy a menudo. Por ejemplo, agregar una hoja de estilo se realiza sin tocar el HTML.
Si necesita actualizar dinámicamente el título de la página en función del contenido, puede usar la API document.title del navegador. Para escenarios más complejos cuando desea cambiar el título de los componentes React, puede usar React Helmet, una biblioteca de terceros.
Si usa un servidor personalizado para su aplicación en producción y desea modificar el título antes de que se envíe al navegador, puede seguir los consejos en esta sección. Alternativamente, puede pre-construir cada página como un archivo HTML estático que luego carga el paquete JavaScript, que se cubre aquí.
El proyecto generado incluye React y Reactom como dependencias. También incluye un conjunto de scripts utilizados por la aplicación Create React como dependencia del desarrollo. Puede instalar otras dependencias (por ejemplo, React Router) con npm :
npm install --save react-router-dom Alternativamente, puede usar yarn :
yarn add react-router-dom Esto funciona para cualquier biblioteca, no solo react-router-dom .
Esta configuración del proyecto admite módulos ES6 gracias a Webpack.
Si bien aún puede usar require() y module.exports , le recomendamos que use import y export en su lugar.
Por ejemplo:
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 ;Tenga en cuenta la diferencia entre las exportaciones predeterminadas y con nombre. Es una fuente común de errores.
Sugerimos que se mantenga en el uso de importaciones y exportaciones predeterminadas cuando un módulo solo exporta una sola cosa (por ejemplo, un componente). Eso es lo que obtienes cuando usas export default Button y import Button from './Button' .
Las exportaciones con nombre son útiles para módulos de servicios públicos que exportan varias funciones. Un módulo puede tener como máximo una exportación predeterminada y tantas exportaciones nombradas como desee.
Obtenga más información sobre los módulos ES6:
En lugar de descargar toda la aplicación antes de que los usuarios puedan usarla, la división del código le permite dividir su código en pequeños fragmentos que luego puede cargar a pedido.
Esta configuración del proyecto admite la división del código a través de Dynamic import() . Su propuesta está en la etapa 3. La forma similar a la función import() toma el nombre del módulo como argumento y devuelve una Promise que siempre se resuelve al objeto del espacio de nombres del módulo.
Aquí hay un ejemplo:
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 ; Esto hará que moduleA.js y todas sus dependencias únicas como un fragmento separado que solo se carga después de que el usuario haga clic en el botón 'Cargar'.
También puede usarlo con sintaxis async / await si lo prefiere.
Si está utilizando React Router, consulte este tutorial sobre cómo usar el código de división con él. Puede encontrar el repositorio complementario de GitHub aquí.
También consulte la sección de división de código en la documentación React.
Esta configuración del proyecto utiliza Webpack para manejar todos los activos. WebPack ofrece una forma personalizada de "extender" el concepto de import más allá de JavaScript. Para expresar que un archivo JavaScript depende de un archivo CSS, debe importar el CSS desde el archivo 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" / > ;
}
}Esto no es necesario para React, pero muchas personas encuentran conveniente esta característica. Puede leer sobre los beneficios de este enfoque aquí. Sin embargo, debe tener en cuenta que esto hace que su código sea menos portátil a otras herramientas y entornos de compilación que Webpack.
En el desarrollo, expresar dependencias de esta manera permite que sus estilos se vuelvan a cargar sobre la marcha mientras los edita. En la producción, todos los archivos CSS se concatenarán en un solo archivo .css minificado en la salida de compilación.
Si le preocupa el uso de semántica específica de Webpack, puede poner todo su CSS directamente en src/index.css . Todavía se importaría de src/index.js , pero siempre puede eliminar esa importación si luego migra a una herramienta de compilación diferente.
Nota: Esta característica está disponible con
[email protected]y superior.
Este proyecto admite módulos CSS junto con hojas de estilo regulares utilizando la Convención de nombres de archivos [name].module.css . Los módulos CSS permiten el alcance de CSS creando automáticamente un nombre de clase único del formato [filename]_[classname]__[hash] .
Consejo: Si desea preprocesar una hoja de estilo con Sass, asegúrese de seguir las instrucciones de instalación y luego cambiar la extensión del archivo de hojas de estilo de la siguiente manera:
[name].module.scsso[name].module.sass.
Los módulos CSS le permiten usar el mismo nombre de clase CSS en diferentes archivos sin preocuparse por nombrar enfrentamientos. Obtenga más información sobre los módulos CSS aquí.
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 > ;
}
} No hay enfrentamientos de otros nombres de clase .error
<!-- This button has red background but not red text -->
< button class =" Button_error_ax7yz " > </ div > Esta es una característica opcional. Las hojas de estilo <link> regulares y los archivos CSS son totalmente compatibles. Los módulos CSS se activan para los archivos que terminan con la extensión .module.css .
Nota: Esta característica está disponible con
[email protected]y superior.
En general, recomendamos que no reutilice las mismas clases de CSS en diferentes componentes. Por ejemplo, en lugar de usar una clase .Button CSS en <AcceptButton> y <RejectButton> Components, recomendamos crear un componente <Button> con sus propios estilos .Button , que tanto <AcceptButton> como <RejectButton> pueden renderizar (pero no heredar).
Seguir esta regla a menudo hace que los preprocesadores de CSS sean menos útiles, ya que las características como las mezclas y la anidación se reemplazan por composición de componentes. Sin embargo, puede integrar un preprocesador CSS si lo encuentra valioso.
Para usar SASS, primero instale node-sass :
$ npm install node-sass --save
$ # or
$ yarn add node-sass Ahora puede cambiar el nombre de src/App.css a src/App.scss y actualizar src/App.js para importar src/App.scss . Este archivo y cualquier otro archivo se compilarán automáticamente si se importan con la extensión .scss o .sass .
Para compartir variables entre los archivos SASS, puede usar Sass Imports. Por ejemplo, src/App.scss y otros archivos de estilo componente podrían incluir @import "./shared.scss"; con definiciones variables.
Esto le permitirá hacer importaciones como
@import ' styles/_colors.scss ' ; // assuming a styles directory under src/
@import ' ~nprogress/nprogress ' ; // importing a css file from the nprogress node moduleConsejo: ¡también puede optar por usar esta función con módulos CSS!
Nota: debe prefijo las importaciones de
node_modulescon~como se muestra arriba.
Esta configuración del proyecto minifica su CSS y agrega prefijos de proveedores automáticamente a través de AutoPrefixer para que no necesite preocuparse por ello.
El soporte para nuevas funciones de CSS, como all las propiedades, propiedades break , propiedades personalizadas y rangos de consultas de medios, se pollan automáticamente para agregar soporte para navegadores más antiguos.
Puede personalizar sus navegadores de soporte objetivo ajustando la tecla browserslist en package.json .
Por ejemplo, esto:
. App {
display : flex;
flex-direction : row;
align-items : center;
}se convierte en esto:
. 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;
}Si necesita deshabilitar el autoprefijo por alguna razón, siga esta sección.
El prefijo del diseño de la cuadrícula CSS está deshabilitado de forma predeterminada, pero no despojará el prefijo manual. Si desea optar por el prefijo de la red CSS, primero familiarícese sobre sus limitaciones.
Para habilitar el prefijo de la cuadrícula CSS, agregar /* autoprefixer grid: on */ A la parte superior de su archivo CSS.
Con Webpack, el uso de activos estáticos como imágenes y fuentes funciona de manera similar a CSS.
Puede import un archivo directamente en un módulo JavaScript . Esto le dice a WebPack que incluya ese archivo en el paquete. A diferencia de las importaciones de CSS, importar un archivo le da un valor de cadena. Este valor es la ruta final que puede hacer referencia en su código, por ejemplo, como el atributo src de una imagen o el href de un enlace a un PDF.
Para reducir el número de solicitudes al servidor, la importación de imágenes que son menos de 10,000 bytes devuelven un URI de datos en lugar de una ruta. Esto se aplica a las siguientes extensiones de archivo: BMP, GIF, JPG, JPEG y PNG. Los archivos SVG se excluyen debido al #1153.
Aquí hay un ejemplo:
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 ;Esto asegura que cuando se construya el proyecto, Webpack moverá correctamente las imágenes a la carpeta de compilación y nos proporcionará rutas correctas.
Esto también funciona en CSS:
. Logo {
background-image : url (. / logo.png);
} Webpack encuentra todas las referencias de módulos relativos en CSS (comienzan con ./ ) y las reemplaza con las rutas finales desde el paquete compilado. Si realiza un error tipográfico o elimina accidentalmente un archivo importante, verá un error de compilación, al igual que cuando importa un módulo JavaScript inexistente. Webpack generan los nombres de archivo finales en el paquete compilado desde el contenido hash. Si el contenido del archivo cambia en el futuro, Webpack le dará un nombre diferente en la producción para que no tenga que preocuparse por el almacenamiento en caché de activos a largo plazo.
Tenga en cuenta que esta también es una característica personalizada de Webpack.
No es necesario para React , pero muchas personas lo disfrutan (y React Native usa un mecanismo similar para las imágenes).
En la siguiente sección se describe una forma alternativa de manejar activos estáticos.
Nota: Esta característica está disponible con
[email protected]y superior.
Una forma de agregar archivos SVG se describió en la sección anterior. También puede importar SVGS directamente como componentes React. Puede usar cualquiera de los dos enfoques. En su código se vería así:
import { ReactComponent as Logo } from './logo.svg' ;
const App = ( ) => (
< div >
{ /* Logo is an actual React component */ }
< Logo / >
< / div >
) ; Esto es útil si no desea cargar SVG como un archivo separado. ¡No olvides los aparatos ortopédicos de la importación! El nombre de importación ReactComponent es especial y le dice a Crear aplicación React que desea un componente React que represente un SVG, en lugar de su nombre de archivo.
publicNota: Esta característica está disponible con
[email protected]y superior.
La carpeta public contiene el archivo HTML para que pueda modificarlo, por ejemplo, para establecer el título de la página. La etiqueta <script> con el código compilado se le agregará automáticamente durante el proceso de compilación.
También puede agregar otros activos a la carpeta public .
Tenga en cuenta que normalmente le recomendamos que import activos en archivos JavaScript. Por ejemplo, consulte las secciones para agregar una hoja de estilo y agregar imágenes y fuentes. Este mecanismo proporciona una serie de beneficios:
Sin embargo, hay una escotilla de escape que puede usar para agregar un activo fuera del sistema de módulos.
Si coloca un archivo en la carpeta public , no será procesado por Webpack. En su lugar, se copiará en la carpeta de compilación intacta. Para hacer referencia a los activos en la carpeta public , debe usar una variable especial llamada PUBLIC_URL .
Inside index.html , puede usarlo así:
< link rel =" shortcut icon " href =" %PUBLIC_URL%/favicon.ico " > Solo se pueden acceder a los archivos dentro de la carpeta public por %PUBLIC_URL% prefix. Si necesita usar un archivo de src o node_modules , deberá copiarlo allí para especificar explícitamente su intención para que este archivo sea parte de la compilación.
Cuando ejecuta npm run build , Crear aplicación React sustituirá %PUBLIC_URL% con una ruta absoluta correcta para que su proyecto funcione incluso si usa el enrutamiento del lado del cliente o lo aloja en una URL sin raíz.
En el código JavaScript, puede usar process.env.PUBLIC_URL para fines similares:
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' } / > ;
}Tenga en cuenta las desventajas de este enfoque:
public se procesa o minifica postprocesados o minificados.public Normalmente recomendamos importar hojas de estilo, imágenes y fuentes de JavaScript. La carpeta public es útil como solución para una serie de casos menos comunes:
manifest.webmanifest .pace.js fuera del código agrupado.<script> . Tenga en cuenta que si agrega un <script> que declara variables globales, también debe leer la siguiente sección sobre el uso.
Cuando incluye un script en el archivo HTML que define las variables globales e intente usar una de estas variables en el código, el enlace se quejará porque no puede ver la definición de la variable.
Puede evitar esto leyendo la variable global explícitamente desde el objeto window , por ejemplo:
const $ = window . $ ;Esto hace que sea obvio que está utilizando una variable global intencionalmente en lugar de debido a un error tipográfico.
Alternativamente, puede obligar al enlace a ignorar cualquier línea agregando // eslint-disable-line después de ella.
No tiene que usar ReactStrap junto con React, pero es una biblioteca popular para integrar Bootstrap con aplicaciones React. Si lo necesita, puede integrarlo con la aplicación Crear React siguiendo estos pasos:
Instale ReactStrap y Bootstrap a partir de NPM. ReactStrap no incluye CSS de arranque, por lo que esto también debe instalarse:
npm install --save reactstrap bootstrap@4 Alternativamente, puede usar yarn :
yarn add bootstrap@4 reactstrap Importar Bootstrap CSS y opcionalmente Bootstrap Tema CSS al comienzo de su archivo 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 reactsprap requeridos dentro del archivo src/App.js o sus archivos de componentes personalizados:
import { Button } from 'reactstrap' ; Ahora está listo para usar los componentes ReactStrap importados dentro de su jerarquía de componentes definidos en el método de renderizado. Aquí hay un ejemplo de App.js reconstruido usando ReactStrap.
Nota: Esta característica está disponible con
[email protected]y superior.
A veces es posible que necesite ajustar los estilos visuales de Bootstrap (o paquete equivalente).
A partir de [email protected] , puede importar archivos .scss . Esto permite utilizar las variables SASS incorporadas de un paquete para preferencias de estilo global.
Para personalizar Bootstrap, cree un archivo llamado src/custom.scss (o similar) e importe la hoja de estilo de fuente de bootstrap. Agregue cualquier anulación antes de los archivos importados. Puede hacer referencia a la documentación de Bootstrap para los nombres de las variables disponibles.
// Override default variables before the import
$body-bg : #000 ;
// Import Bootstrap and its default variables
@import ' ~bootstrap/scss/bootstrap.scss ' ;Nota: debe prefijo las importaciones de
node_modulescon~como se muestra arriba.
Finalmente, importe el archivo .scss recién creado en lugar del Bootstrap .css predeterminado al comienzo de su archivo src/index.js , por ejemplo:
import './custom.scss' ; El flujo es un verificador de tipo estático que lo ayuda a escribir código con menos errores. Consulte esta introducción al uso de tipos estáticos en JavaScript si es nuevo en este concepto.
Versiones recientes de Flow Work con Crear proyectos de aplicaciones React fuera de la caja.
Para agregar flujo a un proyecto Crear aplicación React, siga estos pasos:
npm install --save flow-bin (o yarn add flow-bin )."flow": "flow" a la sección scripts de su package.json .npm run flow init (o yarn flow init ) para crear un archivo .flowconfig en el directorio raíz.// @flow a cualquier archivo que desee escribir (por ejemplo, a src/App.js ). Ahora puede ejecutar npm run flow (o yarn flow ) para verificar los archivos para los errores de tipo. Opcionalmente, puede usar un IDE como Nucleide para una mejor experiencia integrada. En el futuro, planeamos integrarlo en la aplicación Crear React aún más de cerca.
Para obtener más información sobre el flujo, consulte su documentación.
Relay es un marco para construir aplicaciones React basadas en datos alimentadas por GraphQL. El candidato de lanzamiento actual de Relay funciona con Crear proyectos de aplicaciones React fuera de la caja utilizando Babel Macros. Simplemente configure su proyecto como se establece en la documentación del retransmisión, luego asegúrese de tener una versión del complemento Babel que proporcione la macro.
Para agregarlo, ejecute:
npm install --save --dev babel-plugin-relay@dev Alternativamente, puede usar yarn :
yarn upgrade babel-plugin-relay@dev Luego, donde sea que use la etiqueta de plantilla graphql , importe la macro:
import graphql from 'babel-plugin-relay/macro' ;
// instead of:
// import { graphql } from "babel-plugin-relay"
graphql `
query UserQuery {
viewer {
id
}
}
` ;Para obtener más información sobre Relay, consulte su documentación.
Crear aplicación React no prescribe una solución de enrutamiento específica, pero React Router es el más popular.
Para agregarlo, ejecute:
npm install --save react-router-dom Alternativamente, puede usar yarn :
yarn add react-router-dom Para probarlo, elimine todo el código en src/App.js y reemplácelo con cualquiera de los ejemplos en su sitio web. El ejemplo básico es un buen lugar para comenzar.
Tenga en cuenta que es posible que deba configurar su servidor de producción para admitir el enrutamiento del lado del cliente antes de implementar su aplicación.
Nota: Esta característica está disponible con
[email protected]y superior.
Su proyecto puede consumir variables declaradas en su entorno como si fueran declaradas localmente en sus archivos JS. Por defecto, tendrá NODE_ENV definido para usted y cualquier otra variable de entorno que comience con REACT_APP_ .
Las variables de entorno están integradas durante el tiempo de construcción . Dado que Crear aplicación React produce un paquete HTML/CSS/JS estático, no puede leerlos en tiempo de ejecución. Para leerlos en tiempo de ejecución, necesitaría cargar HTML en la memoria en el servidor y reemplazar a los marcadores de posición en tiempo de ejecución, al igual que se describe aquí. Alternativamente, puede reconstruir la aplicación en el servidor cada vez que los cambie.
Nota: debe crear variables de entorno personalizadas que comienzan con
REACT_APP_. Cualquier otra variable, exceptoNODE_ENVse ignorará para evitar exponer accidentalmente una clave privada en la máquina que podría tener el mismo nombre. Cambiar las variables de entorno requerirá que reinicie el servidor de desarrollo si se está ejecutando.
Estas variables de entorno se definirán para usted en process.env . Por ejemplo, tener una variable de entorno llamada REACT_APP_SECRET_CODE se expusirá en su JS como process.env.REACT_APP_SECRET_CODE .
También hay una variable especial de entorno incorporada llamada NODE_ENV . Puede leerlo desde process.env.NODE_ENV . Cuando ejecuta npm start , siempre es igual al 'development' , cuando se ejecuta npm test siempre es igual a 'test' , y cuando ejecuta npm run build para hacer un paquete de producción, siempre es igual a 'production' . No puede anular NODE_ENV manualmente. Esto evita que los desarrolladores implementen accidentalmente una lenta construcción de desarrollo a la producción.
Estas variables de entorno pueden ser útiles para mostrar información condicionalmente en función de dónde se implementa el proyecto o consumir datos confidenciales que viven fuera del control de versiones.
Primero, debe tener variables de entorno definidas. Por ejemplo, supongamos que quería consumir un secreto definido en el entorno dentro de un <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 la compilación, process.env.REACT_APP_SECRET_CODE se reemplazará con el valor actual de la variable de entorno REACT_APP_SECRET_CODE . Recuerde que la variable NODE_ENV se establecerá para usted automáticamente.
Cuando carga la aplicación en el navegador e inspecciona el <input> , verá su valor establecido en abcdef , y el texto en negrita mostrará el entorno proporcionado cuando se use npm start :
< div >
< small > You are running this application in < b > development </ b > mode. </ small >
< form >
< input type =" hidden " value =" abcdef " />
</ form >
</ div > El formulario anterior está buscando una variable llamada REACT_APP_SECRET_CODE desde el entorno. Para consumir este valor, necesitamos tenerlo definido en el entorno. Esto se puede hacer usando dos formas: en su shell o en un archivo .env . Ambas formas se describen en las siguientes secciones.
Tener acceso al NODE_ENV también es útil para realizar acciones condicionalmente:
if ( process . env . NODE_ENV !== 'production' ) {
analytics . disable ( ) ;
} Cuando compile la aplicación con npm run build , el paso de minificación eliminará esta condición, y el paquete resultante será más pequeño.
Nota: Esta característica está disponible con
[email protected]y superior.
También puede acceder a las variables de entorno que comienzan con REACT_APP_ en el public/index.html . Por ejemplo:
< title > %REACT_APP_WEBSITE_NAME% </ title >Tenga en cuenta que se aplican las advertencias de la sección anterior:
NODE_ENV y PUBLIC_URL ), los nombres de variables deben comenzar con REACT_APP_ para funcionar.La definición de las variables de entorno puede variar entre los OMS. También es importante saber que esta manera es temporal para la vida de la sesión de shell.
set " REACT_APP_SECRET_CODE = abcdef " && npm start(Nota: se requieren citas alrededor de la asignación de variables para evitar un espacio en blanco).
( $ env: REACT_APP_SECRET_CODE = " abcdef " ) -and (npm start)REACT_APP_SECRET_CODE=abcdef npm start.envNota: Esta característica está disponible con
[email protected]y superior.
Para definir variables de entorno permanente, cree un archivo llamado .env en la raíz de su proyecto:
REACT_APP_SECRET_CODE=abcdef
Nota: debe crear variables de entorno personalizadas que comienzan con
REACT_APP_. Cualquier otra variable, exceptoNODE_ENVse ignorará para evitar exponer accidentalmente una clave privada en la máquina que podría tener el mismo nombre. Cambiar las variables de entorno requerirá que reinicie el servidor de desarrollo si se está ejecutando.
.env files should be checked into source control (with the exclusion of .env*.local ).
.env files can be used?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 , .envnpm run build : .env.production.local , .env.production , .env.local , .envnpm 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.
.envNote: 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 startNote 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-rendererAs 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.jsonfile 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 ejemplo:
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.jsonfile won't contain any reference to it, so you should manually create the propertysetupTestFrameworkScriptFilein 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:
collectCoverageFromcoverageReporterscoverageThresholdsnapshotSerializersExample 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 buildThe 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 documentReactDOM.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:debugThis 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/cliThen, run the following command inside your app's directory:
getstorybookAfter 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 styleguideAfter 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 -hYou 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> .
Más información aquí.
Por ejemplo:
< 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-cmdpackage.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.comFor 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 deployThen run:
npm run deploygh-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 siteSupport 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.
| Variable | Desarrollo | Producción | 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. | |
| ANFITRIÓN | ✅ | By default, the development web server binds to localhost . You may use this variable to specify a different host. | |
| PUERTO | ✅ | 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 -9on 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 ejemplo:
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!
