kinokong
1.0.0
تم bootstrapped هذا المشروع مع إنشاء تطبيق React.
ستجد أدناه بعض المعلومات حول كيفية أداء المهام الشائعة.
يمكنك العثور على أحدث إصدار من هذا الدليل هنا.
<title>publicpublic.env<meta> على الخادمnpm start لا تكتشف التغييراتnpm test معلق أو يعطل على Macos Sierranpm run build Exkts مبكرًا جدًاnpm run build على Herokunpm run build في Minifyينقسم إنشاء تطبيق React إلى حزمتين:
create-react-app هي أداة سطر أوامر عالمية تستخدمها لإنشاء مشاريع جديدة.react-scripts هي تبعية للتنمية في المشاريع التي تم إنشاؤها (بما في ذلك هذا المظهر). لا تحتاج أبدًا إلى تحديث create-react-app نفسه: إنه ينفصل عن جميع الإعدادات react-scripts .
عندما تقوم create-react-app ، فإنه يقوم دائمًا بإنشاء المشروع مع أحدث إصدار من react-scripts حتى تحصل على جميع الميزات والتحسينات الجديدة في التطبيقات التي تم إنشاؤها حديثًا تلقائيًا.
لتحديث مشروع موجود إلى إصدار جديد من react-scripts ، افتح changelog ، ابحث عن الإصدار الذي تم تشغيله حاليًا (تحقق package.json json في هذا المجلد إذا لم تكن متأكدًا) الإصدارات.
في معظم الحالات ، يجب أن يكون إصدار إصدار react-scripts في package.json npm install (أو yarn install ) في هذا المجلد كافيًا ، لكن من الجيد استشارة Changelog للتغييرات المحتملة.
نلتزم بالحفاظ على تغييرات كسر الحد الأدنى حتى تتمكن من ترقية react-scripts غير المؤلمة.
نحن دائما منفتحون على ملاحظاتك.
بعد الخلق ، يجب أن يبدو مشروعك هكذا:
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
لكي يتم إنشاء المشروع ، يجب أن توجد هذه الملفات مع أسماء الملفات الدقيقة :
public/index.html هو قالب الصفحة ؛src/index.js هي نقطة إدخال JavaScript.يمكنك حذف أو إعادة تسمية الملفات الأخرى.
يمكنك إنشاء دليل فرعي داخل src . لإعادة البناء بشكل أسرع ، تتم معالجة الملفات فقط داخل src بواسطة WebPack.
تحتاج إلى وضع أي ملفات JS و CSS داخل src ، وإلا لن يراها WebPack.
يمكن استخدام الملفات داخل public فقط من public/index.html .
اقرأ التعليمات أدناه لاستخدام الأصول من JavaScript و HTML.
ومع ذلك ، يمكنك إنشاء المزيد من الدلائل ذات المستوى الأعلى.
لن يتم تضمينها في بناء الإنتاج حتى تتمكن من استخدامها لأشياء مثل الوثائق.
في دليل المشروع ، يمكنك تشغيل:
npm start يدير التطبيق في وضع التطوير.
افتح http: // localhost: 3000 لمشاهدته في المتصفح.
سيتم إعادة تحميل الصفحة إذا قمت بإجراء تعديلات.
سترى أيضًا أي أخطاء في وحدة التحكم في وحدة التحكم.
npm test يطلق عداء الاختبار في وضع الساعة التفاعلية.
انظر القسم حول إجراء الاختبارات لمزيد من المعلومات.
npm run build يبني التطبيق للإنتاج إلى مجلد build .
تتفاعل حزمها بشكل صحيح في وضع الإنتاج وتحسن البناء للحصول على أفضل أداء.
تم تصنيع البناء ويتضمن أسماء الملفات التجزئة.
تطبيقك جاهز للنشر!
راجع القسم الخاص بالنشر لمزيد من المعلومات.
npm run eject ملاحظة: هذه عملية في اتجاه واحد. بمجرد eject ، لا يمكنك العودة!
إذا لم تكن راضيًا عن أدوات الإنشاء وخيارات التكوين ، فيمكنك eject في أي وقت. سيقوم هذا الأمر بإزالة التبعية الفردية من مشروعك.
بدلاً من ذلك ، ستقوم بنسخ جميع ملفات التكوين والتبعيات المتعدية (WebPack ، Babel ، ESLINT ، إلخ) مباشرة في مشروعك حتى يكون لديك سيطرة كاملة عليها. ستظل جميع الأوامر باستثناء eject تعمل ، لكنها ستشير إلى البرامج النصية المنسوخة حتى تتمكن من تعديلها. في هذه المرحلة ، أنت وحدك.
ليس عليك استخدام eject . مجموعة الميزات المنسقة مناسبة للنشرات الصغيرة والمتوسطة ، ويجب ألا تشعر بأنك ملزم باستخدام هذه الميزة. ومع ذلك ، فإننا نفهم أن هذه الأداة لن تكون مفيدة إذا لم تتمكن من تخصيصها عندما تكون جاهزًا لذلك.
بشكل افتراضي ، يدعم المشروع الذي تم إنشاؤه جميع المتصفحات الحديثة.
يتطلب دعم Internet Explorer 9 و 10 و 11 من متعدد الأطراف.
يدعم هذا المشروع مجموعة من أحدث معيار JavaScript.
بالإضافة إلى ميزات بناء الجملة ES6 ، فإنه يدعم أيضًا:
تعرف على المزيد حول مراحل الاقتراح المختلفة.
على الرغم من أننا نوصي باستخدام المقترحات التجريبية مع بعض الحذر ، فإن Facebook يستخدم هذه الميزات بشكل كبير في رمز المنتج ، لذلك نعتزم توفير codemods إذا تغير أي من هذه المقترحات في المستقبل.
لاحظ أن هذا المشروع لا يتضمن أي تعددات بشكل افتراضي.
إذا كنت تستخدم أي ميزات ES6+ أخرى تحتاج إلى دعم وقت التشغيل (مثل Array.from() أو Symbol ) ، فتأكد من تضمين عمليات التعليقات المناسبة يدويًا ، أو أن المتصفحات التي تستهدفها بالفعل تدعمها.
لتكوين تمييز بناء الجملة في محرر النص المفضل لديك ، توجه إلى صفحة وثائق بابل ذات الصلة واتبع التعليمات. يتم تغطية بعض المحررين الأكثر شعبية.
ملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
كما أنه يعمل فقط مع NPM 3 أو أعلى.
يوفر بعض المحررين ، بما في ذلك Sublime Text و Atom و Visual Studio Code ، مكونات إضافية لـ ESLINT.
فهي ليست مطلوبة للاندماج. يجب أن ترى إخراج Linter في المحطة الخاصة بك مباشرة وكذلك وحدة التحكم في المتصفح. ومع ذلك ، إذا كنت تفضل أن تظهر نتائج الوبر في المحرر ، فهناك بعض الخطوات الإضافية التي يمكنك القيام بها.
ستحتاج إلى تثبيت مكون إضافي ESLINT للمحرر الخاص بك أولاً. ثم ، أضف ملفًا يسمى .eslintrc إلى جذر المشروع:
{
"extends" : "react-app"
}الآن يجب على المحرر الإبلاغ عن تحذيرات linting.
لاحظ أنه حتى إذا قمت بتحرير ملف .eslintrc الخاص بك ، فإن هذه التغييرات ستؤثر فقط على تكامل المحرر . لن يؤثروا على إخراج الوبر في المحطة والمتصفح. وذلك لأن إنشاء تطبيق React يوفر عمداً مجموعة أقل من القواعد التي تجد أخطاء شائعة.
إذا كنت ترغب في تطبيق نمط الترميز لمشروعك ، ففكر في استخدام أجمل بدلاً من قواعد نمط ESLINT.
يتم دعم هذه الميزة حاليًا فقط بواسطة Visual Studio Code و WebStorm.
تدعم Visual Studio Code و WebStorm تصحيح الأخطاء خارج المربع مع إنشاء تطبيق React. يمكّنك ذلك كمطور من كتابة وتصحيح رمز React الخاص بك دون مغادرة المحرر ، والأهم من ذلك أنه يمكّنك من الحصول على سير عمل تطوير مستمر ، حيث يكون تبديل السياق ضئيلًا ، حيث لا يتعين عليك التبديل بين الأدوات.
ستحتاج إلى الحصول على أحدث إصدار من VS Code و VS Code Chrome Debugger Extension.
ثم أضف الكتلة أدناه إلى ملف launch.json json ووضعه داخل مجلد .vscode في دليل الجذر في التطبيق الخاص بك.
{
"version" : " 0.2.0 " ,
"configurations" : [
{
"name" : " Chrome " ,
"type" : " chrome " ,
"request" : " launch " ,
"url" : " http://localhost:3000 " ,
"webRoot" : " ${workspaceRoot}/src " ,
"sourceMapPathOverrides" : {
"webpack:///src/*" : " ${webRoot}/* "
}
}
]
}ملاحظة: قد يكون عنوان URL مختلفًا إذا قمت بإجراء تعديلات عبر متغيرات بيئة المضيف أو المنفذ.
ابدأ تطبيقك عن طريق تشغيل npm start ، وابدأ تصحيح الأخطاء في VS Code عن طريق الضغط على F5 أو عن طريق النقر على رمز الأخطاء الأخضر. يمكنك الآن كتابة التعليمات البرمجية ، وتعيين نقاط التوقف ، وإجراء تغييرات على الرمز ، وتصحيح رمزك المعدل حديثًا - كل ذلك من المحرر الخاص بك.
وجود مشاكل مع VS Code تصحيح الأخطاء؟ يرجى الاطلاع على دليل استكشاف الأخطاء وإصلاحها.
ستحتاج إلى تثبيت امتداد Chrome Support Ede و JetBrains.
في قائمة WebStorm Run تحرير Edit Configurations... ثم انقر فوق + وحدد JavaScript Debug . لصق http://localhost:3000 في حقل عنوان URL وحفظ التكوين.
ملاحظة: قد يكون عنوان URL مختلفًا إذا قمت بإجراء تعديلات عبر متغيرات بيئة المضيف أو المنفذ.
ابدأ تطبيقك عن طريق تشغيل npm start ، ثم اضغط على ^D على MacOS أو F9 على Windows و Linux أو انقر فوق أيقونة الأخطاء الأخضر لبدء تصحيح الأخطاء في العاصفة.
بنفس الطريقة التي يمكنك بها تصحيح تطبيقك في Idea Idea Ultimate و Phpstorm و Pycharm Pro و Rubymine.
Purttier هو رمز رأي ينسق مع دعم JavaScript و CSS و JSON. مع أجمل ، يمكنك تنسيق الرمز الذي تكتبه تلقائيًا للتأكد من نمط رمز داخل مشروعك. راجع صفحة GitHub الخاصة بجمله للحصول على مزيد من المعلومات ، وانظر إلى هذه الصفحة لرؤيتها في العمل.
لتنسيق الكود لدينا كلما نقضي التزامًا في GIT ، نحتاج إلى تثبيت التبعيات التالية:
npm install --save husky lint-staged prettier بدلاً من ذلك ، يمكنك استخدام yarn :
yarn add husky lint-staged prettierhusky من السهل استخدام githooks كما لو كانت نصوص NPM.lint-staged تشغيل البرامج النصية على الملفات المرحلية في GIT. شاهد منشور المدونة هذا حول Lint staged لمعرفة المزيد عنها.prettier هو جافا سكريبت الذي سنقوم بتشغيله قبل الالتزامات. الآن يمكننا التأكد من تنسيق كل ملف بشكل صحيح عن طريق إضافة بضعة أسطر إلى package.json في جذر المشروع.
أضف الحقل التالي إلى قسم package.json :
+ "husky": {
+ "hooks": {
+ "pre-commit": "lint-staged"
+ }
+ } بعد ذلك ، نضيف حقلًا "Lint Mestaged" إلى package.json ، على سبيل المثال:
"dependencies": {
// ...
},
+ "lint-staged": {
+ "src/**/*.{js,jsx,json,css}": [
+ "prettier --single-quote --write",
+ "git add"
+ ]
+ },
"scripts": { الآن ، كلما قمت بالتزام ، ستقوم أجمل بتنسيق الملفات التي تم تغييرها تلقائيًا. يمكنك أيضًا تشغيل ./node_modules/.bin/prettier --single-quote --write "src/**/*.{js,jsx}" لتنسيق مشروعك بالكامل للمرة الأولى.
بعد ذلك قد ترغب في دمج أجمل في المحرر المفضل لديك. اقرأ القسم الخاص بتكامل المحرر على صفحة github أجمل.
<title> يمكنك العثور على ملف HTML المصدر في المجلد public للمشروع الذي تم إنشاؤه. يمكنك تعديل علامة <title> فيه لتغيير العنوان من "React App" إلى أي شيء آخر.
لاحظ أنك عادة لن تقوم بتحرير الملفات في المجلد public كثيرًا. على سبيل المثال ، تتم إضافة ورقة الأنماط دون لمس HTML.
إذا كنت بحاجة إلى تحديث عنوان الصفحة بشكل ديناميكي بناءً على المحتوى ، فيمكنك استخدام document.title Browser.Title API. للحصول على سيناريوهات أكثر تعقيدًا عندما تريد تغيير العنوان من مكونات React ، يمكنك استخدام React Helmet ، وهي مكتبة طرف ثالث.
إذا كنت تستخدم خادمًا مخصصًا لتطبيقك في الإنتاج وترغب في تعديل العنوان قبل إرساله إلى المتصفح ، فيمكنك اتباع المشورة في هذا القسم. بدلاً من ذلك ، يمكنك بناء كل صفحة مسبقًا كملف HTML ثابت والذي يقوم بعد ذلك بتحميل حزمة JavaScript ، التي يتم تغطيتها هنا.
يتضمن المشروع الذي تم إنشاؤه React و ReactDom كتبعيات. ويتضمن أيضًا مجموعة من البرامج النصية المستخدمة بواسطة Create React App كاعتماد على التطوير. يمكنك تثبيت تبعيات أخرى (على سبيل المثال ، رد فعل React) مع npm :
npm install --save react-router-dom بدلاً من ذلك ، يمكنك استخدام yarn :
yarn add react-router-dom هذا يعمل مع أي مكتبة ، وليس فقط react-router-dom .
يدعم إعداد المشروع وحدات ES6 بفضل WebPack.
على الرغم من أنه لا يزال بإمكانك استخدام require() و module.exports ، فإننا نشجعك على استخدام import export بدلاً من ذلك.
على سبيل المثال:
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 ;كن على دراية بالفرق بين الصادرات الافتراضية والمسمى. إنه مصدر شائع للأخطاء.
نقترح عليك التمسك باستخدام الواردات الافتراضية والصادرات عندما تصدر الوحدة فقط شيئًا واحدًا (على سبيل المثال ، مكون). هذا ما تحصل عليه عند استخدام export default Button import Button from './Button' .
الصادرات المسماة مفيدة لوحدات الأداة المساعدة التي تصدر العديد من الوظائف. قد يكون للوحدة تصدير افتراضي واحد على الأكثر والعديد من الصادرات المسماة كما تريد.
تعرف على المزيد حول وحدات ES6:
بدلاً من تنزيل التطبيق بأكمله قبل أن يتمكن المستخدمون من استخدامه ، يتيح لك تقسيم التعليمات البرمجية تقسيم التعليمات البرمجية الخاصة بك إلى أجزاء صغيرة يمكنك تحميلها عند الطلب.
يدعم إعداد المشروع تقسيم الكود عبر import() . اقتراحه في المرحلة 3. يأخذ النموذج الشبيه بالدالة import() اسم الوحدة كوسيطة ويعيد Promise يحل دائمًا إلى كائن مساحة الاسم في الوحدة النمطية.
هنا مثال:
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 ; سيؤدي ذلك إلى جعل moduleA.js وجميع تبعياتها الفريدة كقطعة منفصلة يتم تحميلها فقط بعد أن ينقر المستخدم على زر "التحميل".
يمكنك أيضًا استخدامه مع بناء جملة async / await إذا كنت تفضل ذلك.
إذا كنت تستخدم جهاز توجيه React ، تحقق من هذا البرنامج التعليمي حول كيفية استخدام تقسيم التعليمات البرمجية معه. يمكنك العثور على مستودع GitHub Companion هنا.
تحقق أيضًا من قسم تقسيم التعليمات البرمجية في وثائق React.
يستخدم إعداد المشروع هذا WebPack للتعامل مع جميع الأصول. يوفر WebPack طريقة مخصصة "لتوسيع" مفهوم import إلى ما وراء JavaScript. للتعبير عن أن ملف JavaScript يعتمد على ملف CSS ، تحتاج إلى استيراد CSS من ملف 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" / > ;
}
}هذا غير مطلوب للرد ، لكن الكثير من الناس يجدون هذه الميزة مريحة. يمكنك أن تقرأ عن فوائد هذا النهج هنا. ومع ذلك ، يجب أن تدرك أن هذا يجعل الكود أقل قدرًا على أدوات وبيئات البناء الأخرى من WebPack.
في التطوير ، يتيح التعبير عن التبعيات بهذه الطريقة أن يتم إعادة تحميل أساليبك أثناء الطيران أثناء تعديلها. في الإنتاج ، سيتم تسلسل جميع ملفات CSS في ملف .css واحد MINISED في إخراج البناء.
إذا كنت قلقًا بشأن استخدام دلالات WebPack الخاصة ، فيمكنك وضع جميع CSS مباشرة في src/index.css . لا يزال يتم استيراده من src/index.js ، ولكن يمكنك دائمًا إزالة هذا الاستيراد إذا قمت بالترحيل لاحقًا إلى أداة بناء مختلفة.
ملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
يدعم هذا المشروع وحدات CSS جنبًا إلى جنب مع أوراق الأنماط العادية باستخدام [name].module.css file convention. تتيح وحدات CSS تحديد النطاق لـ CSS عن طريق إنشاء اسم فئة فريد من التنسيق [filename]_[classname]__[hash] .
نصيحة: إذا كنت ترغب في معالجة ورقة الأنماط مع Sass ثم تأكد من اتباع تعليمات التثبيت ثم تغيير امتداد ملف ورقة الأنماط على النحو التالي:
[name].module.scssأو[name].module.sass.
تتيح لك وحدات CSS استخدام نفس اسم فئة CSS في ملفات مختلفة دون القلق بشأن تسمية الاشتباكات. تعرف على المزيد حول وحدات CSS هنا.
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 > ;
}
} لا اشتباكات من أسماء .error أخرى
<!-- This button has red background but not red text -->
< button class =" Button_error_ax7yz " > </ div > هذه ميزة اختيارية. يتم دعم ملفات <link> وملفات CSS العادية بشكل كامل. يتم تشغيل وحدات CSS للملفات التي تنتهي مع امتداد .module.css .
ملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
بشكل عام ، نوصي بعدم إعادة استخدام فصول CSS نفسها عبر مكونات مختلفة. على سبيل المثال ، بدلاً <RejectButton> استخدام فئة .Button ولكن من مكونات CSS في <AcceptButton> و <RejectButton> <AcceptButton> نوصي بإنشاء مكون <Button> مع أنماطه .Button ورث).
اتباع هذه القاعدة غالبًا ما يجعل المعالجات المسبقة CSS أقل فائدة ، حيث يتم استبدال ميزات مثل Mixins و Nesting بتكوين المكون. ومع ذلك ، يمكنك دمج المعالج المسبق CSS إذا وجدت أنها ذات قيمة.
لاستخدام SASS ، قم أولاً بتثبيت node-sass :
$ npm install node-sass --save
$ # or
$ yarn add node-sass يمكنك الآن إعادة تسمية src/App.css إلى src/App.scss وتحديث src/App.js لاستيراد src/App.scss . سيتم تجميع هذا الملف وأي ملف آخر تلقائيًا إذا تم استيراده باستخدام Extension .scss أو .sass .
لمشاركة المتغيرات بين ملفات SASS ، يمكنك استخدام واردات SASS. على سبيل المثال ، يمكن أن تتضمن src/App.scss وملفات نمط المكون الأخرى @import "./shared.scss"; مع تعريفات متغيرة.
سيتيح لك ذلك القيام بالواردات مثل
@import ' styles/_colors.scss ' ; // assuming a styles directory under src/
@import ' ~nprogress/nprogress ' ; // importing a css file from the nprogress node moduleنصيحة: يمكنك اختيار استخدام هذه الميزة مع وحدات CSS أيضا!
ملاحظة: يجب عليك بادئة الواردات من
node_modulesمع~كما هو موضح أعلاه.
يقوم إعداد المشروع هذا بإعداد CSS الخاص بك ويضيف بادئات البائع إليها تلقائيًا من خلال Autoprefixer حتى لا تحتاج إلى القلق بشأن ذلك.
يتم دعم دعم ميزات CSS الجديدة مثل all الممتلكات ، وخصائص break ، والخصائص المخصصة ، ونطاقات الاستعلام عن الوسائط تلقائيًا لإضافة دعم للمتصفحات القديمة.
يمكنك تخصيص متصفحات الدعم المستهدف عن طريق ضبط مفتاح browserslist في package.json مسئولين عن مواصفات قائمة المتصفح.
على سبيل المثال ، هذا:
. App {
display : flex;
flex-direction : row;
align-items : center;
}يصبح هذا:
. 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;
}إذا كنت بحاجة إلى تعطيل Autoprefixing لسبب ما ، فاتبع هذا القسم.
يتم تعطيل بادئة تخطيط شبكة CSS افتراضيًا ، لكنها لن تجرد بادئة يدوي. إذا كنت ترغب في الاشتراك في بادئة شبكة CSS ، تعرّف نفسك أولاً على قيودها.
لتمكين بادئة شبكة CSS ، أضف /* autoprefixer grid: on */ إلى أعلى ملف CSS الخاص بك.
باستخدام WebPack ، يعمل استخدام الأصول الثابتة مثل الصور والخطوط بشكل مشابه لـ CSS.
يمكنك import ملف مباشرة في وحدة JavaScript . هذا يخبر WebPack بتضمين هذا الملف في الحزمة. على عكس واردات CSS ، يمنحك استيراد ملف قيمة سلسلة. هذه القيمة هي المسار النهائي الذي يمكنك الإشارة إليه في الكود الخاص بك ، على سبيل المثال ، كسممة src لصورة أو href لرابط إلى PDF.
لتقليل عدد الطلبات إلى الخادم ، يقوم استيراد الصور التي تقل عن 10000 بايت بإرجاع URI للبيانات بدلاً من المسار. ينطبق هذا على ملحقات الملف التالية: BMP و GIF و JPG و JPEG و PNG. يتم استبعاد ملفات SVG بسبب #1153.
هنا مثال:
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 ;هذا يضمن أنه عند بناء المشروع ، ستقوم WebPack بنقل الصور بشكل صحيح إلى مجلد الإنشاء ، وتزويدنا بالمسارات الصحيحة.
هذا يعمل في CSS أيضا:
. Logo {
background-image : url (. / logo.png);
} يجد WebPack جميع مراجع الوحدة النمطية النسبية في CSS (تبدأ بـ ./ ) واستبدالها بالمسارات النهائية من الحزمة المترجمة. إذا قمت بإجراء خطأ مطبعي أو حذف ملفًا مهمًا عن طريق الخطأ ، فسترى خطأ في التجميع ، تمامًا مثلما تقوم باستيراد وحدة JavaScript غير الموجودة. يتم إنشاء أسماء الملفات النهائية في الحزمة المترجمة بواسطة WebPack من تجزئة المحتوى. إذا تغير محتوى الملف في المستقبل ، فسوف يمنحه WebPack اسمًا مختلفًا في الإنتاج ، لذا لا داعي للقلق بشأن التخزين المؤقت للأصول على المدى الطويل.
يرجى العلم أن هذه ميزة مخصصة لـ WebPack.
ليس مطلوبًا للرد ، لكن الكثير من الناس يستمتعون به (ويستخدم React Native آلية مماثلة للصور).
تم وصف طريقة بديلة للتعامل مع الأصول الثابتة في القسم التالي.
ملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
تم وصف طريقة واحدة لإضافة ملفات SVG في القسم أعلاه. يمكنك أيضًا استيراد SVGs مباشرة كمكونات React. يمكنك استخدام أي من النهجين. في الكود الخاص بك ، سيبدو هكذا:
import { ReactComponent as Logo } from './logo.svg' ;
const App = ( ) => (
< div >
{ /* Logo is an actual React component */ }
< Logo / >
< / div >
) ; هذا مفيد إذا كنت لا ترغب في تحميل SVG كملف منفصل. لا تنسَ أقواس مجعد في الاستيراد! اسم الاستيراد ReactComponent خاص ويخبر Create React بأنك تريد مكون React الذي يجعل SVG ، بدلاً من اسم ملفه.
publicملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
يحتوي المجلد public على ملف HTML حتى تتمكن من تعديله ، على سبيل المثال ، لتعيين عنوان الصفحة. سيتم إضافة علامة <script> مع الكود المترجم إليه تلقائيًا أثناء عملية الإنشاء.
يمكنك أيضًا إضافة أصول أخرى إلى المجلد public .
لاحظ أننا نشجعك عادة على import الأصول في ملفات JavaScript بدلاً من ذلك. على سبيل المثال ، راجع الأقسام الخاصة بإضافة ورقة الأنماط وإضافة الصور والخطوط. توفر هذه الآلية عددًا من الفوائد:
ومع ذلك ، هناك فتحة للهروب يمكنك استخدامها لإضافة أصل خارج نظام الوحدة النمطية.
إذا وضعت ملفًا في المجلد public ، فلن تتم معالجته بواسطة WebPack. بدلاً من ذلك ، سيتم نسخه في مجلد البناء دون مساس. للإشارة إلى الأصول في المجلد public ، تحتاج إلى استخدام متغير خاص يسمى PUBLIC_URL .
داخل index.html ، يمكنك استخدامه مثل هذا:
< link rel =" shortcut icon " href =" %PUBLIC_URL%/favicon.ico " > يمكن الوصول إلى الملفات الموجودة داخل المجلد public بنسبة %PUBLIC_URL% فقط. إذا كنت بحاجة إلى استخدام ملف من src أو node_modules ، فسيتعين عليك نسخه هناك لتحديد نيتك بشكل صريح لجعل هذا الملف جزءًا من الإنشاء.
عند تشغيل npm run build ، سيقوم إنشاء تطبيق React باستبدال %PUBLIC_URL% مع المسار المطلق الصحيح بحيث يعمل مشروعك حتى إذا كنت تستخدم التوجيه من جانب العميل أو استضافته في عنوان URL غير الجذر.
في رمز JavaScript ، يمكنك استخدام process.env.PUBLIC_URL لأغراض مماثلة:
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' } / > ;
}ضع في اعتبارك الجوانب السلبية لهذا النهج:
public على معالجة ما بعد المعالجة أو المصنعة.public عادةً ما نوصي باستيراد أوراق الأنماط والصور والخطوط من JavaScript. المجلد public مفيد باعتباره حلًا لعدد من الحالات الأقل شيوعًا:
manifest.webmanifest .pace.js خارج الكود المجمع.<script> . لاحظ أنه إذا قمت بإضافة <script> التي تعلن عن المتغيرات العالمية ، فأنت بحاجة أيضًا إلى قراءة القسم التالي حول استخدامها.
عندما تقوم بتضمين برنامج نصي في ملف HTML الذي يحدد المتغيرات العالمية ومحاولة استخدام أحد هذه المتغيرات في الكود ، فإن Linter سوف يشكو لأنه لا يمكن أن يرى تعريف المتغير.
يمكنك تجنب ذلك من خلال قراءة المتغير العالمي بشكل صريح من كائن window ، على سبيل المثال:
const $ = window . $ ;هذا يجعل من الواضح أنك تستخدم متغيرًا عالميًا عن قصد وليس بسبب الخطأ المطبعي.
بدلاً من ذلك ، يمكنك إجبار Linter على تجاهل أي سطر عن طريق إضافة // eslint-disable-line بعده.
ليس عليك استخدام ReactStrap مع React ولكنها مكتبة شهيرة لدمج Bootstrap مع تطبيقات React. إذا كنت في حاجة إليها ، يمكنك دمجها مع إنشاء تطبيق React من خلال اتباع هذه الخطوات:
تثبيت ReactStrap و Bootstrap من NPM. لا يتضمن ReactStrap CSS Bootstrap ، لذا يجب تثبيت هذا أيضًا:
npm install --save reactstrap bootstrap@4 بدلاً من ذلك ، يمكنك استخدام yarn :
yarn add bootstrap@4 reactstrap استيراد Bootstrap CSS و CSS موضوعات Bootstrap اختياريًا في بداية ملف 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. استيراد مكونات ReactStrap المطلوبة في ملف src/App.js أو ملفات المكون المخصصة:
import { Button } from 'reactstrap' ; أنت الآن مستعد لاستخدام مكونات ReactStrap المستوردة ضمن التسلسل الهرمي المكون المحدد في طريقة العرض. فيما يلي مثال App.js باستخدام REACTSTRAP.
ملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
في بعض الأحيان قد تحتاج إلى تعديل الأنماط المرئية للتمهيد (أو الحزمة المكافئة).
اعتبارًا من [email protected] يمكنك استيراد ملفات .scss . هذا يجعل من الممكن استخدام متغيرات SASS المدمجة للحزمة لتفضيلات النمط العالمي.
لتخصيص bootstrap ، قم بإنشاء ملف يسمى src/custom.scss (أو ما شابه) واستيراد ورقة أنماط مصدر bootstrap. إضافة أي تجاوزات قبل الملف (الملفات) المستوردة. يمكنك الرجوع إلى وثائق Bootstrap لأسماء المتغيرات المتاحة.
// Override default variables before the import
$body-bg : #000 ;
// Import Bootstrap and its default variables
@import ' ~bootstrap/scss/bootstrap.scss ' ;ملاحظة: يجب عليك بادئة الواردات من
node_modulesمع~كما هو موضح أعلاه.
أخيرًا ، استيراد ملف .scss الذي تم إنشاؤه حديثًا بدلاً من .css الافتراضي src/index.js
import './custom.scss' ; التدفق هو مدقق نوع ثابت يساعدك على كتابة رمز مع وجود أخطاء أقل. تحقق من هذه المقدمة لاستخدام أنواع ثابتة في JavaScript إذا كنت جديدًا في هذا المفهوم.
تعمل الإصدارات الحديثة من Flow مع Create React App Projects Out Out of the Box.
لإضافة التدفق إلى مشروع تطبيق React ، اتبع هذه الخطوات:
npm install --save flow-bin (أو yarn add flow-bin )."flow": "flow" إلى قسم scripts في package.json الخاصة بك.npm run flow init (أو yarn flow init ) لإنشاء ملف .flowconfig في دليل الجذر.// @flow إلى أي ملفات تريد الكتابة (على سبيل المثال ، إلى src/App.js ). يمكنك الآن تشغيل npm run flow (أو yarn flow ) للتحقق من الملفات للحصول على أخطاء الكتابة. يمكنك اختياريا استخدام IDE مثل Nuclide لتجربة متكاملة أفضل. في المستقبل ، نخطط لدمجه في إنشاء تطبيق React عن كثب.
لمعرفة المزيد حول التدفق ، تحقق من وثائقها.
Relay هو إطار لإنشاء تطبيقات React التي تعتمد على البيانات مدعوم من GraphQL. يعمل مرشح الإصدار الحالي لـ RELAY مع Create React App Projects Out Out of the Box باستخدام وحدات الماكرو بابل. ما عليك سوى إعداد مشروعك كما هو موضح في وثائق الترحيل ، ثم تأكد من أن لديك إصدارًا من المكون الإضافي Babel الذي يوفر الماكرو.
لإضافته ، قم بتشغيل:
npm install --save --dev babel-plugin-relay@dev بدلاً من ذلك ، يمكنك استخدام yarn :
yarn upgrade babel-plugin-relay@dev ثم ، أينما كنت تستخدم علامة قالب graphql ، استيراد الماكرو:
import graphql from 'babel-plugin-relay/macro' ;
// instead of:
// import { graphql } from "babel-plugin-relay"
graphql `
query UserQuery {
viewer {
id
}
}
` ;لمعرفة المزيد حول الترحيل ، تحقق من وثائقها.
لا يصف Create React App حل توجيه محدد ، لكن REACT Router هو الأكثر شعبية.
لإضافته ، قم بتشغيل:
npm install --save react-router-dom بدلاً من ذلك ، يمكنك استخدام yarn :
yarn add react-router-dom لتجربتها ، قم بحذف جميع الكود في src/App.js واستبداله بأي من الأمثلة على موقعه على الويب. المثال الأساسي هو مكان جيد للبدء.
لاحظ أنك قد تحتاج إلى تكوين خادم الإنتاج الخاص بك لدعم التوجيه من جانب العميل قبل نشر تطبيقك.
ملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
يمكن أن يستهلك مشروعك المتغيرات المعلنة في بيئتك كما لو تم الإعلان عنها محليًا في ملفات JS الخاصة بك. بشكل افتراضي ، سيكون لديك NODE_ENV محدد لك ، وأي متغيرات بيئة أخرى تبدأ بـ REACT_APP_ .
يتم تضمين متغيرات البيئة خلال وقت البناء . نظرًا لأن إنشاء تطبيق React ينتج حزمة HTML/CSS/JS ثابتة ، فلا يمكن قراءتها في وقت التشغيل. لقراءتها في وقت التشغيل ، ستحتاج إلى تحميل HTML في الذاكرة على الخادم واستبدال العناصر النائبة في وقت التشغيل ، تمامًا كما هو موضح هنا. بدلاً من ذلك ، يمكنك إعادة بناء التطبيق على الخادم في أي وقت تقوم فيه بتغييره.
ملاحظة: يجب عليك إنشاء متغيرات بيئة مخصصة تبدأ بـ
REACT_APP_. سيتم تجاهل أي متغيرات أخرى باستثناءNODE_ENVلتجنب تعريض مفتاح خاص عن طريق الخطأ على الجهاز الذي يمكن أن يكون له نفس الاسم. سيتطلب تغيير أي متغيرات البيئة إعادة تشغيل خادم التطوير إذا كان قيد التشغيل.
سيتم تعريف متغيرات البيئة هذه لك على process.env . على سبيل المثال ، سيتم عرض متغير البيئة المسمى REACT_APP_SECRET_CODE في JS الخاص بك process.env.REACT_APP_SECRET_CODE .
يوجد أيضًا متغير خاص للبيئة مدمج يسمى NODE_ENV . يمكنك قراءتها من process.env.NODE_ENV . عندما تقوم بتشغيل npm start ، يكون الأمر دائمًا مساويًا لـ 'development' ، وعندما تقوم بتشغيل npm test فإنه يساوي دائمًا 'test' ، وعندما تقوم بتشغيل npm run build لعمل حزمة إنتاج ، فإنه يساوي دائمًا 'production' . لا يمكنك تجاوز NODE_ENV يدويًا. هذا يمنع المطورين من نشر البناء البطيء للتطوير إلى الإنتاج بطريق الخطأ.
يمكن أن تكون متغيرات البيئة هذه مفيدة لعرض المعلومات بشكل مشروط بناءً على المكان الذي يتم فيه نشر المشروع أو استهلاك البيانات الحساسة التي تعيش خارج التحكم في الإصدار.
أولاً ، تحتاج إلى تحديد متغيرات البيئة. على سبيل المثال ، دعنا نقول أنك تريد أن تستهلك سرًا محددًا في البيئة داخل <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 >
) ;
} أثناء الإنشاء ، سيتم استبدال process.env.REACT_APP_SECRET_CODE بالقيمة الحالية لمتغير بيئة REACT_APP_SECRET_CODE . تذكر أنه سيتم تعيين متغير NODE_ENV لك تلقائيًا.
عندما تقوم بتحميل التطبيق في المتصفح وفحص <input> ، سترى تعيين قيمته على abcdef ، وسيظهر النص الغامق البيئة المقدمة عند استخدام npm start :
< div >
< small > You are running this application in < b > development </ b > mode. </ small >
< form >
< input type =" hidden " value =" abcdef " />
</ form >
</ div > يبحث النموذج أعلاه عن متغير يسمى REACT_APP_SECRET_CODE من البيئة. من أجل استهلاك هذه القيمة ، نحتاج إلى تحديدها في البيئة. يمكن القيام بذلك باستخدام طريقتين: إما في قذيفك أو في ملف .env . يتم وصف كل من هذه الطرق في الأقسام القليلة التالية.
يعد الوصول إلى NODE_ENV مفيدًا أيضًا في إجراء الإجراءات بشكل مشروط:
if ( process . env . NODE_ENV !== 'production' ) {
analytics . disable ( ) ;
} عند تجميع التطبيق باستخدام npm run build ، ستقوم خطوة التصوير بتجريد هذا الشرط ، وستكون الحزمة الناتجة أصغر.
ملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
يمكنك أيضًا الوصول إلى متغيرات البيئة التي تبدأ بـ REACT_APP_ في public/index.html . على سبيل المثال:
< title > %REACT_APP_WEBSITE_NAME% </ title >لاحظ أن التحذيرات من القسم أعلاه تنطبق:
NODE_ENV و PUBLIC_URL ) ، يجب أن تبدأ الأسماء المتغيرة مع REACT_APP_ للعمل.يمكن أن تختلف متغيرات البيئة بين الأنظمة. من المهم أيضًا معرفة أن هذه الطريقة مؤقتة لحياة جلسة الصدفة.
set " REACT_APP_SECRET_CODE = abcdef " && npm start(ملاحظة: هناك حاجة إلى عروض أسعار حول المهمة المتغيرة لتجنب مساحة بيضاء زائدة.)
( $ env: REACT_APP_SECRET_CODE = " abcdef " ) -and (npm start)REACT_APP_SECRET_CODE=abcdef npm start.envملاحظة: تتوفر هذه الميزة مع
[email protected]وأعلى.
لتحديد متغيرات البيئة الدائمة ، قم بإنشاء ملف يسمى .env في جذر مشروعك:
REACT_APP_SECRET_CODE=abcdef
ملاحظة: يجب عليك إنشاء متغيرات بيئة مخصصة تبدأ بـ
REACT_APP_. سيتم تجاهل أي متغيرات أخرى باستثناءNODE_ENVلتجنب تعريض مفتاح خاص عن طريق الخطأ على الجهاز الذي يمكن أن يكون له نفس الاسم. Changing any environment variables will require you to restart the development server if it is running.
.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.
على سبيل المثال:
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> .
More information here.
على سبيل المثال:
< 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.
| عامل | تطوير | إنتاج | الاستخدام |
|---|---|---|---|
| BROWSER | ✅ | 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. | |
| يستضيف | ✅ | By default, the development web server binds to localhost . You may use this variable to specify a different host. | |
| ميناء | ✅ | 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.
على سبيل المثال:
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!
