kinokong
1.0.0
Ce projet a été enraciné avec Create React App.
Vous trouverez ci-dessous quelques informations sur la façon d'effectuer des tâches courantes.
Vous pouvez trouver la version la plus récente de ce guide ici.
<title>publicpublic.env<meta> dynamiques sur le serveurnpm start ne détecte pas les modificationsnpm test est suspendu ou plant sur macOS Sierranpm run build sort trop tôtnpm run build échoue sur Herokunpm run build ne parvient pas à minimerLa création de l'application React est divisée en deux packages:
create-react-app est un utilitaire de ligne de commande mondiale que vous utilisez pour créer de nouveaux projets.react-scripts est une dépendance au développement dans les projets générés (y compris celui-ci). Vous n'avez presque jamais besoin de mettre à jour create-react-app lui-même: il délègue toute la configuration react-scripts .
Lorsque vous exécutez create-react-app , il crée toujours le projet avec la dernière version de react-scripts afin d'obtenir automatiquement toutes les nouvelles fonctionnalités et améliorations des applications nouvellement créées.
Pour mettre à jour un projet existant vers une nouvelle version de react-scripts , ouvrez le Changelog, trouvez la version dans laquelle vous êtes actuellement (vérifiez package.json dans ce dossier si vous n'êtes pas sûr) et appliquez les instructions de migration pour le nouveau versions.
Dans la plupart des cas, la baisse de la version react-scripts dans package.json et l'exécution npm install (ou yarn install ) dans ce dossier devraient suffire, mais il est bon de consulter le changelog pour les changements de rupture potentiels.
Nous nous engageons à garder les changements de rupture minimaux afin que vous puissiez mettre à niveau react-scripts sans douleur.
Nous sommes toujours ouverts à vos commentaires.
Après la création, votre projet devrait ressembler à ceci:
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
Pour que le projet soit construit, ces fichiers doivent exister avec des noms de fichiers exacts :
public/index.html est le modèle de page;src/index.js est le point d'entrée JavaScript.Vous pouvez supprimer ou renommer les autres fichiers.
Vous pouvez créer des sous-répertoires à l'intérieur src . Pour des reconstructions plus rapides, seuls les fichiers à l'intérieur src sont traités par WebPack.
Vous devez mettre des fichiers JS et CSS dans src , sinon WebPack ne les verra pas.
Seuls les fichiers à l'intérieur public peuvent être utilisés à partir de public/index.html .
Lisez les instructions ci-dessous pour utiliser les actifs de JavaScript et HTML.
Vous pouvez cependant créer plus de répertoires de haut niveau.
Ils ne seront pas inclus dans la construction de production afin que vous puissiez les utiliser pour des choses comme la documentation.
Dans le répertoire du projet, vous pouvez courir:
npm start Exécute l'application en mode développement.
Ouvrez http: // localhost: 3000 pour le voir dans le navigateur.
La page se rechargera si vous effectuez des modifications.
Vous verrez également toutes les erreurs de peluche dans la console.
npm test Lance le coureur de test en mode de montre interactif.
Voir la section concernant l'exécution des tests pour plus d'informations.
npm run build Créez l'application pour la production dans le dossier build .
Il réagit correctement en mode de production et optimise la construction pour les meilleures performances.
La construction est minifiée et les noms de fichiers incluent les hachages.
Votre application est prête à être déployée!
Voir la section sur le déploiement pour plus d'informations.
npm run eject Remarque: il s'agit d'une opération à sens unique. Une fois que vous eject , vous ne pouvez pas revenir en arrière!
Si vous n'êtes pas satisfait de l'outil de construction et des choix de configuration, vous pouvez eject à tout moment. Cette commande supprimera la dépendance à la construction unique de votre projet.
Au lieu de cela, il copiera tous les fichiers de configuration et les dépendances transitives (WebPack, Babel, Eslint, etc.) dans votre projet afin que vous ayez un contrôle complet sur eux. Toutes les commandes, sauf eject fonctionneront toujours, mais elles pointent vers les scripts copiés afin que vous puissiez les ajuster. À ce stade, vous êtes seul.
Vous n'avez jamais à utiliser eject . L'ensemble de fonctionnalités organisé convient aux déploiements petits et intermédiaires, et vous ne devriez pas vous sentir obligé d'utiliser cette fonctionnalité. Cependant, nous comprenons que cet outil ne serait pas utile si vous ne pouviez pas le personnaliser lorsque vous êtes prêt pour cela.
Par défaut, le projet généré prend en charge tous les navigateurs modernes.
La prise en charge d'Internet Explorer 9, 10 et 11 nécessite des polyfills.
Ce projet prend en charge un superset de la dernière norme JavaScript.
En plus des fonctionnalités de syntaxe ES6, il prend également en charge:
En savoir plus sur les différentes étapes de proposition.
Bien que nous recommandons d'utiliser des propositions expérimentales avec une certaine prudence, Facebook utilise fortement ces fonctionnalités dans le code produit, nous avons donc l'intention de fournir des codemods si l'une de ces propositions change à l'avenir.
Notez que ce projet ne comprend pas de polyfills par défaut.
Si vous utilisez d'autres fonctionnalités ES6 + qui nécessitent une prise en charge d'exécution (telle que Array.from() ou Symbol ), assurez-vous d'inclure manuellement les polyfills appropriés, ou que les navigateurs que vous ciblent les soutiennent déjà.
Pour configurer la mise en évidence de la syntaxe dans votre éditeur de texte préféré, dirigez-vous vers la page de documentation BABEL pertinente et suivez les instructions. Certains des éditeurs les plus populaires sont couverts.
Remarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Il ne fonctionne également qu'avec le NPM 3 ou plus.
Certains éditeurs, y compris le texte sublime, l'atome et le code Visual Studio, fournissent des plugins pour Eslint.
Ils ne sont pas nécessaires pour la libellur. Vous devriez voir la sortie Linter directement dans votre terminal ainsi que la console du navigateur. Cependant, si vous préférez que les résultats des peluches apparaissent directement dans votre éditeur, vous pouvez faire quelques étapes supplémentaires.
Vous devrez d'abord installer un plugin Eslint pour votre éditeur. Ensuite, ajoutez un fichier appelé .eslintrc à la racine du projet:
{
"extends" : "react-app"
}Maintenant, votre éditeur devrait signaler les avertissements de liaison.
Notez que même si vous modifiez davantage votre fichier .eslintrc , ces modifications affecteront uniquement l'intégration de l'éditeur . Ils n'affecteront pas la sortie de peluche terminale et de navigateur. En effet, Create React App fournit intentionnellement un ensemble minimal de règles qui trouvent des erreurs courantes.
Si vous souhaitez appliquer un style de codage pour votre projet, envisagez d'utiliser des règles de style plus jolies au lieu des règles de style Eslint.
Cette fonctionnalité n'est actuellement prise en charge que par Visual Studio Code et WebStorm.
Le code Visual Studio et la prise en charge de la prise en charge de la boutique de réduction de la boîte avec une application Create React. Cela vous permet en tant que développeur d'écrire et de déboguer votre code de réaction sans quitter l'éditeur, et surtout il vous permet d'avoir un flux de travail de développement continu, où la commutation de contexte est minime, car vous n'avez pas à basculer entre les outils.
Vous auriez besoin que la dernière version de VS Code et VS Code Chrome Debugger Extension soit installée.
Ensuite, ajoutez le bloc ci-dessous dans votre fichier launch.json et placez-le dans le dossier .vscode dans le répertoire racine de votre application.
{
"version" : " 0.2.0 " ,
"configurations" : [
{
"name" : " Chrome " ,
"type" : " chrome " ,
"request" : " launch " ,
"url" : " http://localhost:3000 " ,
"webRoot" : " ${workspaceRoot}/src " ,
"sourceMapPathOverrides" : {
"webpack:///src/*" : " ${webRoot}/* "
}
}
]
}Remarque: L'URL peut être différente si vous avez effectué des ajustements via les variables d'environnement hôte ou port.
Démarrez votre application en exécutant npm start et commencez à déboguer dans VS Code en appuyant sur F5 ou en cliquant sur l'icône de débogage vert. Vous pouvez désormais écrire du code, définir des points d'arrêt, apporter des modifications au code et déboguer votre code nouvellement modifié, le tout de votre éditeur.
Vous avez des problèmes avec le débogage du code vs? Veuillez consulter leur guide de dépannage.
Vous auriez besoin d'installation d'installation de l'extension de chrome de prise en charge de Jet-Brains et de JetBrains.
Dans le menu WebStorm Run Sélectionnez Edit Configurations... Puis cliquez sur + et sélectionnez JavaScript Debug . Collez http://localhost:3000 dans le champ URL et enregistrez la configuration.
Remarque: L'URL peut être différente si vous avez effectué des ajustements via les variables d'environnement hôte ou port.
Démarrez votre application en exécutant npm start , puis appuyez sur ^D sur macOS ou F9 sur Windows et Linux ou cliquez sur l'icône de débogage vert pour démarrer le débogage dans Webstorm.
De la même manière, vous pouvez déboguer votre application dans Intellij Idea Ultimate, Phpstorm, PyCharm Pro et Rumbymine.
Gettier est un formateur de code d'opinion avec le support pour JavaScript, CSS et JSON. Avec plus joli, vous pouvez formater le code que vous écrivez automatiquement pour assurer un style de code dans votre projet. Voir la page GitHub du plus joli pour plus d'informations et regardez cette page pour la voir en action.
Pour formater notre code chaque fois que nous nous engageons dans GIT, nous devons installer les dépendances suivantes:
npm install --save husky lint-staged prettier Vous pouvez également utiliser yarn :
yarn add husky lint-staged prettierhusky facilite l'utilisation de githooks comme s'ils sont des scripts NPM.lint-staged nous permet d'exécuter des scripts sur des fichiers mis en scène dans GIT. Consultez cet article de blog sur les peluches pour en savoir plus à ce sujet.prettier est le formateur JavaScript que nous exécuterons avant les validations. Nous pouvons maintenant nous assurer que chaque fichier est correctement formaté en ajoutant quelques lignes à package.json dans la racine du projet.
Ajoutez le champ suivant à la section package.json :
+ "husky": {
+ "hooks": {
+ "pre-commit": "lint-staged"
+ }
+ } Ensuite, nous ajoutons un champ `` en stage 'à The package.json , par exemple:
"dependencies": {
// ...
},
+ "lint-staged": {
+ "src/**/*.{js,jsx,json,css}": [
+ "prettier --single-quote --write",
+ "git add"
+ ]
+ },
"scripts": { Désormais, chaque fois que vous vous engagez, plus joli, il formara automatiquement les fichiers modifiés. Vous pouvez également exécuter ./node_modules/.bin/prettier --single-quote --write "src/**/*.{js,jsx}" pour formater l'ensemble de votre projet pour la première fois.
Ensuite, vous voudrez peut-être intégrer plus joli dans votre éditeur préféré. Lisez la section sur l'intégration de l'éditeur sur la page GitHub plus jolie.
<title> Vous pouvez trouver le fichier HTML source dans le dossier public du projet généré. Vous pouvez éditer la balise <title> pour changer le titre de «React App» à toute autre chose.
Notez que normalement vous ne modifieriez pas très souvent les fichiers dans le dossier public . Par exemple, l'ajout d'une feuille de style se fait sans toucher le HTML.
Si vous devez mettre à jour dynamiquement le titre de la page en fonction du contenu, vous pouvez utiliser l'API document.title . Pour des scénarios plus complexes Lorsque vous souhaitez modifier le titre à partir des composants React, vous pouvez utiliser React Helmet, une bibliothèque tierce.
Si vous utilisez un serveur personnalisé pour votre application en production et que vous souhaitez modifier le titre avant d'être envoyé au navigateur, vous pouvez suivre les conseils dans cette section. Alternativement, vous pouvez pré-construire chaque page en tant que fichier HTML statique qui charge ensuite le bundle JavaScript, qui est couvert ici.
Le projet généré comprend React et Reactdom sous forme de dépendances. Il comprend également un ensemble de scripts utilisés par Create React App comme dépendance de développement. Vous pouvez installer d'autres dépendances (par exemple, React Router) avec npm :
npm install --save react-router-dom Vous pouvez également utiliser yarn :
yarn add react-router-dom Cela fonctionne pour n'importe quelle bibliothèque, pas seulement react-router-dom .
Cette configuration de projet prend en charge les modules ES6 grâce à WebPack.
Bien que vous puissiez toujours utiliser require() et module.exports , nous vous encourageons à utiliser import et export à la place.
Par exemple:
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 ;Soyez conscient de la différence entre les exportations par défaut et nommées. C'est une source courante d'erreurs.
Nous vous suggérons de vous en tenir à l'utilisation d'importations et d'exportations par défaut lorsqu'un module exporte uniquement une seule chose (par exemple, un composant). C'est ce que vous obtenez lorsque vous utilisez export default Button et import Button from './Button' .
Les exportations nommées sont utiles pour les modules d'utilité qui exportent plusieurs fonctions. Un module peut avoir au plus une exportation par défaut et autant d'exportations nommées que vous le souhaitez.
En savoir plus sur les modules ES6:
Au lieu de télécharger l'ensemble de l'application avant que les utilisateurs puissent l'utiliser, le fractionnement du code vous permet de diviser votre code en petits morceaux que vous pouvez ensuite charger à la demande.
Cette configuration de projet prend en charge la division du code via Dynamic import() . Sa proposition est à l'étape 3. La forme import() en forme de fonction prend le nom du module comme argument et renvoie une Promise qui résout toujours à l'objet d'espace de noms du module.
Voici un exemple:
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 ; Cela fera moduleA.js et de toutes ses dépendances uniques en tant que morceau séparé qui ne se charge qu'après que l'utilisateur a cliqué sur le bouton «Charge».
Vous pouvez également l'utiliser avec une syntaxe async / await si vous le préférez.
Si vous utilisez React Router, consultez ce didacticiel sur la façon d'utiliser le fractionnement du code avec lui. Vous pouvez trouver le référentiel complémentaire GitHub ici.
Consultez également la section de division du code dans la documentation React.
Cette configuration de projet utilise WebPack pour gérer tous les actifs. WebPack offre un moyen personnalisé de «prolonger» le concept d' import au-delà de JavaScript. Pour exprimer qu'un fichier JavaScript dépend d'un fichier CSS, vous devez importer le CSS à partir du fichier 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" / > ;
}
}Ce n'est pas nécessaire pour réagir, mais beaucoup de gens trouvent cette fonctionnalité pratique. Vous pouvez lire les avantages de cette approche ici. Cependant, vous devez savoir que cela rend votre code moins portable sur d'autres outils et environnements de construction que WebPack.
En développement, l'expression des dépendances de cette façon permet à vos styles d'être rechargés à la volée lorsque vous les modifiez. En production, tous les fichiers CSS seront concaténés en un seul fichier .css minifié dans la sortie de build.
Si vous êtes préoccupé par l'utilisation de la sémantique spécifique à WebPack, vous pouvez mettre tous vos CSS directement dans src/index.css . Il serait toujours importé de src/index.js , mais vous pouvez toujours supprimer cette importation si vous migrez plus tard vers un autre outil de construction.
Remarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Ce projet prend en charge les modules CSS aux côtés de styles de styles réguliers à l'aide de la convention de dénomination du fichier [name].module.css . Les modules CSS permettent la portée de CSS en créant automatiquement un nom de classe unique du format [filename]_[classname]__[hash] .
Astuce: Si vous souhaitez prétraiter une feuille de style avec SASS, assurez-vous de suivre les instructions d'installation, puis de modifier l'extension du fichier de feuille de style comme suit:
[name].module.scssou[name].module.sass.
Les modules CSS vous permettent d'utiliser le même nom de classe CSS dans différents fichiers sans vous soucier des affrontements de dénomination. En savoir plus sur les modules CSS ici.
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 > ;
}
} Aucun affrontement des autres noms de classe .error
<!-- This button has red background but not red text -->
< button class =" Button_error_ax7yz " > </ div > Il s'agit d'une fonctionnalité facultative. Les fichiers réguliers <link> Styleshets et CSS sont entièrement pris en charge. Les modules CSS sont activés pour les fichiers se terminant par l'extension .module.css .
Remarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Généralement, nous vous recommandons de ne pas réutiliser les mêmes classes CSS sur différents composants. Par exemple, au lieu d'utiliser une classe .Button CSS dans les composants <AcceptButton> et <RejectButton> , nous vous recommandons de créer un composant <Button> avec ses propres styles .Button , que <AcceptButton> et <RejectButton> peuvent rendre (mais pas hériter).
Suivre cette règle rend souvent les préprocesseurs CSS moins utiles, car des caractéristiques telles que les mélanges et la nidification sont remplacées par la composition des composants. Vous pouvez cependant intégrer un préprocesseur CSS si vous le trouvez précieux.
Pour utiliser SASS, installez d'abord node-sass :
$ npm install node-sass --save
$ # or
$ yarn add node-sass Vous pouvez maintenant renommer src/App.css à src/App.scss et mettre à jour src/App.js pour importer src/App.scss . Ce fichier et tout autre fichier seront automatiquement compilés s'ils sont importés avec l'extension .scss ou .sass .
Pour partager des variables entre les fichiers SASS, vous pouvez utiliser les importations SASS. Par exemple, src/App.scss et d'autres fichiers de style de composant pourraient inclure @import "./shared.scss"; avec des définitions variables.
Cela vous permettra de faire des importations comme
@import ' styles/_colors.scss ' ; // assuming a styles directory under src/
@import ' ~nprogress/nprogress ' ; // importing a css file from the nprogress node moduleAstuce: vous pouvez également utiliser cette fonctionnalité avec des modules CSS!
Remarque: vous devez préfixer les importations à partir de
node_modulesavec~comme affiché ci-dessus.
Ce projet configure mon CSS et y ajoute des préfixes de fournisseurs automatiquement via AutopRefixer afin que vous n'ayez pas à vous en soucier.
La prise en charge des nouvelles fonctionnalités CSS comme la propriété all , les propriétés break , les propriétés personnalisées et les gammes de requête multimédia sont automatiquement polyvalentes pour ajouter la prise en charge des navigateurs plus anciens.
Vous pouvez personnaliser vos navigateurs d'assistance cibles en ajustant la clé de browserslist dans package.json Acciant à la spécification de liste de navigateurs.
Par exemple, ceci:
. App {
display : flex;
flex-direction : row;
align-items : center;
}devient ceci:
. 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 vous devez désactiver l'autoprefixage pour une raison quelconque, suivez cette section.
La préfixe de mise en page de la grille CSS est désactivée par défaut, mais elle ne dépassera pas la préfixation manuelle. Si vous souhaitez vous opter pour la préfixe de la grille CSS, vous familiarisez d'abord sur ses limites.
Pour activer la préfixe de la grille CSS, ajoutez /* autoprefixer grid: on */ en haut de votre fichier CSS.
Avec WebPack, l'utilisation d'actifs statiques comme les images et les polices fonctionne de manière similaire à CSS.
Vous pouvez import un fichier directement dans un module JavaScript . Cela indique à WebPack d'inclure ce fichier dans le bundle. Contrairement aux importations CSS, l'importation d'un fichier vous donne une valeur de chaîne. Cette valeur est le chemin final que vous pouvez référence dans votre code, par exemple comme l'attribut src d'une image ou le href d'un lien vers un PDF.
Pour réduire le nombre de demandes au serveur, l'importation d'images inférieures à 10 000 octets renvoie un URI de données au lieu d'un chemin. Cela s'applique aux extensions de fichiers suivantes: BMP, GIF, JPG, JPEG et PNG. Les fichiers SVG sont exclus en raison du # 1153.
Voici un exemple:
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 ;Cela garantit que lorsque le projet est construit, WebPack déplacera correctement les images dans le dossier de construction et nous fournira des chemins corrects.
Cela fonctionne aussi dans CSS:
. Logo {
background-image : url (. / logo.png);
} WebPack trouve toutes les références de modules relatives dans CSS (ils commencent par ./ ) et les remplace par les chemins finaux du bundle compilé. Si vous créez une faute de frappe ou supprimez accidentellement un fichier important, vous verrez une erreur de compilation, tout comme lorsque vous importez un module JavaScript inexistant. Les noms de fichiers finaux du bundle compilé sont générés par WebPack à partir de hachages de contenu. Si le contenu du fichier change à l'avenir, WebPack lui donnera un nom différent en production afin que vous n'ayez pas à vous soucier de la mise en cache à long terme des actifs.
Veuillez noter qu'il s'agit également d'une fonctionnalité personnalisée de WebPack.
Il n'est pas nécessaire pour réagir , mais de nombreuses personnes l'apprécient (et React Native utilise un mécanisme similaire pour les images).
Un autre moyen de gérer les actifs statiques est décrit dans la section suivante.
Remarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Une façon d'ajouter des fichiers SVG a été décrite dans la section ci-dessus. Vous pouvez également importer directement des SVG sous forme de composants React. Vous pouvez utiliser l'une des deux approches. Dans votre code, cela ressemblerait à ceci:
import { ReactComponent as Logo } from './logo.svg' ;
const App = ( ) => (
< div >
{ /* Logo is an actual React component */ }
< Logo / >
< / div >
) ; C'est pratique si vous ne souhaitez pas charger SVG en tant que fichier séparé. N'oubliez pas les accolades bouclées dans l'importation! Le nom d'importation ReactComponent est spécial et indique à Create React App que vous voulez un composant React qui rend un SVG, plutôt que son nom de fichier.
publicRemarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Le dossier public contient le fichier HTML afin que vous puissiez le modifier, par exemple, pour définir le titre de la page. La balise <script> avec le code compilé y sera ajouté automatiquement pendant le processus de construction.
Vous pouvez également ajouter d'autres actifs au dossier public .
Notez que nous vous encourageons normalement à import des actifs dans des fichiers JavaScript à la place. Par exemple, consultez les sections sur l'ajout d'une feuille de style et l'ajout d'images et de polices. Ce mécanisme offre un certain nombre d'avantages:
Cependant, il y a une trappe d'évacuation que vous pouvez utiliser pour ajouter un actif en dehors du système de module.
Si vous mettez un fichier dans le dossier public , il ne sera pas traité par WebPack. Au lieu de cela, il sera copié dans le dossier de construction intact. Pour référencer les actifs dans le dossier public , vous devez utiliser une variable spéciale appelée PUBLIC_URL .
Inside index.html , vous pouvez l'utiliser comme ceci:
< link rel =" shortcut icon " href =" %PUBLIC_URL%/favicon.ico " > Seuls les fichiers dans le dossier public seront accessibles par %PUBLIC_URL% préfixe. Si vous devez utiliser un fichier à partir de src ou node_modules , vous devrez le copier là-bas pour spécifier explicitement votre intention de faire de ce fichier une partie de la version.
Lorsque vous exécutez npm run build , créez l'application React remplacera %PUBLIC_URL% avec un chemin absolu correct afin que votre projet fonctionne même si vous utilisez le routage côté client ou l'hébergez à une URL non racinaire.
Dans le code JavaScript, vous pouvez utiliser process.env.PUBLIC_URL à des fins similaires:
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' } / > ;
}Gardez à l'esprit les inconvénients de cette approche:
public n'est post-traité ou minifié.public Normalement, nous recommandons d'importer des feuilles de style, des images et des polices de JavaScript. Le dossier public est utile comme solution de contournement pour un certain nombre de cas moins courants:
manifest.webmanifest .pace.js en dehors du code groupé.<script> . Notez que si vous ajoutez un <script> qui déclare les variables globales, vous devez également lire la section suivante sur les utiliser.
Lorsque vous incluez un script dans le fichier HTML qui définit les variables globales et essayez d'utiliser l'une de ces variables dans le code, le linter se plaindra car il ne peut pas voir la définition de la variable.
Vous pouvez éviter cela en lisant explicitement la variable globale à partir de l'objet window , par exemple:
const $ = window . $ ;Cela rend évident que vous utilisez une variable globale intentionnellement plutôt qu'en raison d'une faute de frappe.
Alternativement, vous pouvez forcer le linter à ignorer n'importe quelle ligne en ajoutant // eslint-disable-line après.
Vous n'avez pas à utiliser ReactsStrap avec React, mais c'est une bibliothèque populaire pour intégrer Bootstrap avec les applications React. Si vous en avez besoin, vous pouvez l'intégrer avec Create React App en suivant ces étapes:
Installez ReagtsStrap et Bootstrap à partir de NPM. ReactsStrap n'inclut pas Bootstrap CSS, donc cela doit également être installé:
npm install --save reactstrap bootstrap@4 Vous pouvez également utiliser yarn :
yarn add bootstrap@4 reactstrap Importer Bootstrap CSS et éventuellement le thème bootstrap CSS au début de votre fichier 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. Importez les composants Reactsstrap requis dans le fichier src/App.js ou vos fichiers de composants personnalisés:
import { Button } from 'reactstrap' ; Vous êtes maintenant prêt à utiliser les composants Reactsstrap importés dans votre hiérarchie de composants définie dans la méthode de rendu. Voici un exemple App.js refait à l'aide de ReactStrap.
Remarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Parfois, vous devrez peut-être modifier les styles visuels de bootstrap (ou un package équivalent).
À partir de [email protected] , vous pouvez importer des fichiers .scss . Cela permet d'utiliser les variables SASS intégrées d'un package pour les préférences de style global.
Pour personnaliser Bootstrap, créez un fichier appelé src/custom.scss (ou similaire) et importez la feuille de style source bootstrap. Ajoutez des remplacements avant le (s) fichier importé. Vous pouvez référencer la documentation de Bootstrap pour les noms des variables disponibles.
// Override default variables before the import
$body-bg : #000 ;
// Import Bootstrap and its default variables
@import ' ~bootstrap/scss/bootstrap.scss ' ;Remarque: vous devez préfixer les importations à partir de
node_modulesavec~comme affiché ci-dessus.
Enfin, importez le fichier .scss nouvellement créé au lieu du bootstrap .css par défaut au début de votre fichier src/index.js , par exemple:
import './custom.scss' ; Le flux est un vérificateur de type statique qui vous aide à écrire du code avec moins de bogues. Consultez cette introduction à l'utilisation de types statiques dans JavaScript si vous êtes nouveau dans ce concept.
Les versions récentes de Flow Work avec Créer des projets d'applications React Out of the Box.
Pour ajouter du flux à un projet Create React App, suivez ces étapes:
npm install --save flow-bin (ou yarn add flow-bin )."flow": "flow" dans la section scripts de votre package.json .npm run flow init (ou yarn flow init ) pour créer un fichier .flowconfig dans le répertoire racine.// @flow à tous les fichiers que vous souhaitez taper vérifier (par exemple, à src/App.js ). Vous pouvez maintenant exécuter npm run flow (ou yarn flow ) pour vérifier les fichiers pour les erreurs de type. Vous pouvez éventuellement utiliser un IDE comme NucLide pour une expérience mieux intégrée. À l'avenir, nous prévoyons de l'intégrer dans Create React App de plus près.
Pour en savoir plus sur le flux, consultez sa documentation.
Le relais est un cadre pour créer des applications REACT basées sur les données alimentées par GraphQL. Le candidat actuel de la version de relais fonctionne avec Create React App Projects Out of the Box à l'aide de macros Babel. Configurez simplement votre projet comme indiqué dans la documentation de relais, puis assurez-vous d'avoir une version du plugin Babel fournissant la macro.
Pour l'ajouter, exécuter:
npm install --save --dev babel-plugin-relay@dev Vous pouvez également utiliser yarn :
yarn upgrade babel-plugin-relay@dev Ensuite, partout où vous utilisez la balise de modèle graphql , importez la macro:
import graphql from 'babel-plugin-relay/macro' ;
// instead of:
// import { graphql } from "babel-plugin-relay"
graphql `
query UserQuery {
viewer {
id
}
}
` ;Pour en savoir plus sur le relais, consultez sa documentation.
Créer l'application React ne prescrit pas une solution de routage spécifique, mais React Router est le plus populaire.
Pour l'ajouter, exécuter:
npm install --save react-router-dom Vous pouvez également utiliser yarn :
yarn add react-router-dom Pour l'essayer, supprimez tout le code de src/App.js et remplacez-le par l'un des exemples de son site Web. L'exemple de base est un bon endroit pour commencer.
Notez que vous devrez peut-être configurer votre serveur de production pour prendre en charge le routage côté client avant de déployer votre application.
Remarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Votre projet peut consommer des variables déclarées dans votre environnement comme si elles étaient déclarées localement dans vos fichiers JS. Par défaut, vous aurez NODE_ENV défini pour vous, et toutes les autres variables d'environnement commençant par REACT_APP_ .
Les variables d'environnement sont intégrées pendant la durée de construction . Étant donné que la création de l'application React produit un bundle HTML / CSS / JS statique, il ne peut pas les lire lors de l'exécution. Pour les lire au moment de l'exécution, vous devrez charger HTML en mémoire sur le serveur et remplacer les espaces réservés dans l'exécution, tout comme décrit ici. Vous pouvez également reconstruire l'application sur le serveur chaque fois que vous les modifiez.
Remarque: vous devez créer des variables d'environnement personnalisées commençant par
REACT_APP_. Toute autre variable saufNODE_ENVsera ignorée pour éviter d'exposer accidentellement une clé privée sur la machine qui pourrait avoir le même nom. La modification des variables d'environnement vous obligera à redémarrer le serveur de développement s'il s'exécute.
Ces variables d'environnement seront définies pour vous sur process.env . Par exemple, avoir une variable d'environnement nommée REACT_APP_SECRET_CODE sera exposée dans votre js en tant que process.env.REACT_APP_SECRET_CODE .
Il existe également une variable d'environnement intégrée spéciale appelée NODE_ENV . Vous pouvez le lire à partir de process.env.NODE_ENV . Lorsque vous exécutez npm start , il est toujours égal au 'development' , lorsque vous exécutez npm test il est toujours égal au 'test' , et lorsque vous exécutez npm run build pour faire un bundle de production, il est toujours égal à 'production' . Vous ne pouvez pas remplacer manuellement NODE_ENV . Cela empêche les développeurs de déployer accidentellement une construction de développement lente à la production.
Ces variables d'environnement peuvent être utiles pour afficher des informations conditionnellement en fonction de l'endroit où le projet est déployé ou de la consommation de données sensibles qui vivent en dehors du contrôle des versions.
Tout d'abord, vous devez faire défini les variables d'environnement. Par exemple, disons que vous vouliez consommer un secret défini dans l'environnement à l'intérieur d'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 >
) ;
} Pendant la construction, process.env.REACT_APP_SECRET_CODE sera remplacé par la valeur actuelle de la variable d'environnement REACT_APP_SECRET_CODE . N'oubliez pas que la variable NODE_ENV sera définie pour vous automatiquement.
Lorsque vous chargez l'application dans le navigateur et inspectez le <input> , vous verrez sa valeur définie sur abcdef , et le texte en gras affichera l'environnement fourni lors de l'utilisation npm start :
< div >
< small > You are running this application in < b > development </ b > mode. </ small >
< form >
< input type =" hidden " value =" abcdef " />
</ form >
</ div > Le formulaire ci-dessus est à la recherche d'une variable appelée REACT_APP_SECRET_CODE à partir de l'environnement. Afin de consommer cette valeur, nous devons le faire défini dans l'environnement. Cela peut être fait en utilisant deux façons: soit dans votre shell ou dans un fichier .env . Ces deux façons sont décrites dans les prochaines sections.
Avoir accès à la NODE_ENV est également utile pour effectuer des actions conditionnellement:
if ( process . env . NODE_ENV !== 'production' ) {
analytics . disable ( ) ;
} Lorsque vous compilez l'application avec npm run build , l'étape de minification supprimera cette condition et le bundle résultant sera plus petit.
Remarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Vous pouvez également accéder aux variables d'environnement à partir de REACT_APP_ dans le public/index.html . Par exemple:
< title > %REACT_APP_WEBSITE_NAME% </ title >Notez que les mises en garde de la section ci-dessus s'appliquent:
NODE_ENV et PUBLIC_URL ), les noms de variables doivent commencer par REACT_APP_ pour fonctionner.La définition des variables d'environnement peut varier entre les ESS. Il est également important de savoir que cette manière est temporaire pour la vie de la séance de coquille.
set " REACT_APP_SECRET_CODE = abcdef " && npm start(Remarque: les citations autour de l'affectation variable sont nécessaires pour éviter un espace blanc.)
( $ env: REACT_APP_SECRET_CODE = " abcdef " ) -and (npm start)REACT_APP_SECRET_CODE=abcdef npm start.envRemarque: Cette fonctionnalité est disponible avec
[email protected]et plus.
Pour définir les variables d'environnement permanentes, créez un fichier appelé .env à la racine de votre projet:
REACT_APP_SECRET_CODE=abcdef
Remarque: vous devez créer des variables d'environnement personnalisées commençant par
REACT_APP_. Toute autre variable saufNODE_ENVsera ignorée pour éviter d'exposer accidentellement une clé privée sur la machine qui pourrait avoir le même nom. La modification des variables d'environnement vous obligera à redémarrer le serveur de développement s'il s'exécute.
.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.
Par exemple:
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> .
Plus d'informations ici.
Par exemple:
< 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 deployPuis courez:
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 | Développement | Production | Usage |
|---|---|---|---|
| NAVIGATEUR | ✅ | 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. | |
| HÔTE | ✅ | By default, the development web server binds to localhost . You may use this variable to specify a different host. | |
| PORT | ✅ | 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.
Par exemple:
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!
