mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Updated docs for next
This commit is contained in:
Website Deployment Script
@@ -39,7 +39,7 @@
|
||||
|
||||
</span><h2><a class="anchor" name="setting-up-an-ios-device"></a>Setting up an iOS device <a class="hash-link" href="docs/running-on-device.html#setting-up-an-ios-device">#</a></h2><p>Installing an app on an iOS device requires a Mac, an Apple ID, and a USB cable.</p><span><block class="mac ios" />
|
||||
|
||||
</span><p>Connect your device to your Mac via USB, then open Xcode. In the project navigator, choose your device from the Scheme toolbar menu. Xcode will then register your device for development.</p><blockquote><p>If you run into any issues, please take a look at Apple's <a href="https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/LaunchingYourApponDevices/LaunchingYourApponDevices.html#//apple_ref/doc/uid/TP40012582-CH27-SW4" target="_blank">Launching Your App on a Device docs</a>.</p></blockquote><p>Finally, select your phone as the build target and press **Build and run(()).</p><span><block class="mac windows linux android" />
|
||||
</span><p>Connect your device to your Mac via USB, then open Xcode. In the project navigator, choose your device from the Scheme toolbar menu. Xcode will then register your device for development.</p><blockquote><p>If you run into any issues, please take a look at Apple's <a href="https://developer.apple.com/library/content/documentation/IDEs/Conceptual/AppDistributionGuide/LaunchingYourApponDevices/LaunchingYourApponDevices.html#//apple_ref/doc/uid/TP40012582-CH27-SW4" target="_blank">Launching Your App on a Device docs</a>.</p></blockquote><p>Finally, select your phone as the build target and press <strong>Build and run</strong>.</p><span><block class="mac windows linux android" />
|
||||
|
||||
</span><h2><a class="anchor" name="setting-up-an-android-device"></a>Setting up an Android device <a class="hash-link" href="docs/running-on-device.html#setting-up-an-android-device">#</a></h2><p>Running an Android app on a device requires a Mac or PC and a USB cable.</p><h3><a class="anchor" name="1-enable-debugging-over-usb"></a>1. Enable Debugging over USB <a class="hash-link" href="docs/running-on-device.html#1-enable-debugging-over-usb">#</a></h3><p>Most Android devices can only install and run apps downloaded from Google Play, by default. You will need to enable USB Debugging on your device in order to install your app during development.</p><p>To enable USB debugging on your device, you will first need to enable the "Developer options" menu by going to <strong>Settings</strong> → <strong>About phone</strong> and then tapping the <code>Build number</code> row at the bottom seven times. You can then go back to <strong>Settings</strong> → <strong>Developer options</strong> to enable "USB debugging".</p><h3><a class="anchor" name="2-plug-in-your-device-via-usb"></a>2. Plug in your device via USB <a class="hash-link" href="docs/running-on-device.html#2-plug-in-your-device-via-usb">#</a></h3><p>Let's now set up an Android device to run our React Native projects. Go ahead and plug in your device via USB to your development machine.</p><span><block class="linux android" />
|
||||
|
||||
|
||||
@@ -2,14 +2,42 @@
|
||||
and other goodies. Because React Native projects are essentially made up of an Android project, an
|
||||
iOS project and a JavaScript project, all combined under an npm package, upgrading can be rather
|
||||
tricky. But we try to make it easy for you. Here's what you need to do to upgrade from an older
|
||||
version of React Native:</p><h2><a class="anchor" name="1-upgrade-the-react-native-dependency"></a>1. Upgrade the <code>react-native</code> dependency <a class="hash-link" href="docs/upgrading.html#1-upgrade-the-react-native-dependency">#</a></h2><p>Note the latest version of the <code>react-native</code> npm package from here (or use <code>npm info react-native</code> to check):</p><ul><li><a href="https://www.npmjs.com/package/react-native">https://www.npmjs.com/package/react-native</a></li></ul><p>Now install that version of <code>react-native</code> in your project with <code>npm install --save</code>:</p><div class="prism language-javascript">$ npm install <span class="token operator">--</span>save react<span class="token operator">-</span>native@X<span class="token punctuation">.</span>Y
|
||||
version of React Native:</p><h2><a class="anchor" name="upgrade-based-on-git"></a>Upgrade based on Git <a class="hash-link" href="docs/upgrading.html#upgrade-based-on-git">#</a></h2><p><strong>IMPORTANT:</strong> You don't have to install the new version of React Native, it will be installed automatically.</p><p>The module <code>react-native-git-upgrade</code> provides a one-step operation to upgrade the source files with
|
||||
a minimum of conflicts. Under the hood, it consists in 2 phases:</p><ul><li>First, it computes a Git patch between both old and new template files,</li><li>Then, the patch is applied on the user's sources.</li></ul><h3><a class="anchor" name="1-install-git"></a>1. Install Git <a class="hash-link" href="docs/upgrading.html#1-install-git">#</a></h3><p>Your project doesn't have to be handled by the Git versioning sytem (could be Mercurial, SVN or none)
|
||||
but Git has to be installed and available in the <code>PATH</code>. You can download Git here:
|
||||
<a href="https://git-scm.com/downloads">https://git-scm.com/downloads</a></p><h3><a class="anchor" name="2-install-the-react-native-git-upgrade-module"></a>2. Install the <code>react-native-git-upgrade</code> module <a class="hash-link" href="docs/upgrading.html#2-install-the-react-native-git-upgrade-module">#</a></h3><p>It's a CLI tool and must be installed globally:</p><div class="prism language-javascript">$ npm install <span class="token operator">-</span>g react<span class="token operator">-</span>native<span class="token operator">-</span>git<span class="token operator">-</span>upgrade</div><h3><a class="anchor" name="3-run-the-command"></a>3. Run the command <a class="hash-link" href="docs/upgrading.html#3-run-the-command">#</a></h3><p>Run the command to start the process:</p><div class="prism language-javascript">$ react<span class="token operator">-</span>native<span class="token operator">-</span>git<span class="token operator">-</span>upgrade
|
||||
# Upgrade React Native to the latest version
|
||||
|
||||
# Or<span class="token punctuation">:</span>
|
||||
|
||||
$ react<span class="token operator">-</span>native<span class="token operator">-</span>git<span class="token operator">-</span>upgrade X<span class="token punctuation">.</span>Y<span class="token punctuation">.</span>Z
|
||||
# Upgrade React Native to the X<span class="token punctuation">.</span>Y<span class="token punctuation">.</span>Z version</div><p>The templates are upgraded in a optimized way. You still may encounter conflicts but only where the Git
|
||||
3-way merge have failed, depending on the version and how you modified your sources.</p><h3><a class="anchor" name="4-resolve-the-conflicts"></a>4. Resolve the conflicts <a class="hash-link" href="docs/upgrading.html#4-resolve-the-conflicts">#</a></h3><p>Conflicted files include delimiters which make very clear where the changes come from. For example:</p><div class="prism language-javascript">13B07F951A680F5B00A75B9A <span class="token comment" spellcheck="true">/* Release */</span> <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||
isa <span class="token operator">=</span> XCBuildConfiguration<span class="token punctuation">;</span>
|
||||
buildSettings <span class="token operator">=</span> <span class="token punctuation">{</span>
|
||||
ASSETCATALOG_COMPILER_APPICON_NAME <span class="token operator">=</span> AppIcon<span class="token punctuation">;</span>
|
||||
<<<<<<< ours
|
||||
CODE_SIGN_IDENTITY <span class="token operator">=</span> <span class="token string">"iPhone Developer"</span><span class="token punctuation">;</span>
|
||||
FRAMEWORK_SEARCH_PATHS <span class="token operator">=</span> <span class="token punctuation">(</span>
|
||||
<span class="token string">"$(inherited)"</span><span class="token punctuation">,</span>
|
||||
<span class="token string">"$(PROJECT_DIR)/HockeySDK.embeddedframework"</span><span class="token punctuation">,</span>
|
||||
<span class="token string">"$(PROJECT_DIR)/HockeySDK-iOS/HockeySDK.embeddedframework"</span><span class="token punctuation">,</span>
|
||||
<span class="token punctuation">)</span><span class="token punctuation">;</span>
|
||||
<span class="token operator">===</span><span class="token operator">===</span><span class="token operator">=</span>
|
||||
CURRENT_PROJECT_VERSION <span class="token operator">=</span> <span class="token number">1</span><span class="token punctuation">;</span>
|
||||
<span class="token operator">></span><span class="token operator">></span><span class="token operator">></span><span class="token operator">></span><span class="token operator">></span><span class="token operator">></span><span class="token operator">></span> theirs
|
||||
HEADER_SEARCH_PATHS <span class="token operator">=</span> <span class="token punctuation">(</span>
|
||||
<span class="token string">"$(inherited)"</span><span class="token punctuation">,</span>
|
||||
<span class="token operator">/</span>Applications<span class="token operator">/</span>Xcode<span class="token punctuation">.</span>app<span class="token operator">/</span>Contents<span class="token operator">/</span>Developer<span class="token operator">/</span>Toolchains<span class="token operator">/</span>XcodeDefault<span class="token punctuation">.</span>xctoolchain<span class="token operator">/</span>usr<span class="token operator">/</span>include<span class="token punctuation">,</span>
|
||||
<span class="token string">"$(SRCROOT)/../node_modules/react-native/React/**"</span><span class="token punctuation">,</span>
|
||||
<span class="token string">"$(SRCROOT)/../node_modules/react-native-code-push/ios/CodePush/**"</span><span class="token punctuation">,</span>
|
||||
<span class="token punctuation">)</span><span class="token punctuation">;</span></div><p>You can think of "ours" as "your team" and "theirs" as "the React Native dev team".</p><h2><a class="anchor" name="alternative"></a>Alternative <a class="hash-link" href="docs/upgrading.html#alternative">#</a></h2><p>Use this only in case the above didn't work.</p><h3><a class="anchor" name="1-upgrade-the-react-native-dependency"></a>1. Upgrade the <code>react-native</code> dependency <a class="hash-link" href="docs/upgrading.html#1-upgrade-the-react-native-dependency">#</a></h3><p>Note the latest version of the <code>react-native</code> npm package from here (or use <code>npm info react-native</code> to check):</p><ul><li><a href="https://www.npmjs.com/package/react-native">https://www.npmjs.com/package/react-native</a></li></ul><p>Now install that version of <code>react-native</code> in your project with <code>npm install --save</code>:</p><div class="prism language-javascript">$ npm install <span class="token operator">--</span>save react<span class="token operator">-</span>native@X<span class="token punctuation">.</span>Y
|
||||
# where X<span class="token punctuation">.</span>Y is the semantic version you are upgrading to
|
||||
npm WARN peerDependencies The peer dependency react@<span class="token operator">~</span>R included from react<span class="token operator">-</span>native<span class="token punctuation">.</span><span class="token punctuation">.</span><span class="token punctuation">.</span></div><p>If you saw a warning about the peerDependency, also upgrade <code>react</code> by running:</p><div class="prism language-javascript">$ npm install <span class="token operator">--</span>save react@R
|
||||
# where R is the <span class="token keyword">new</span> <span class="token class-name">version</span> of react from the peerDependency warning you saw</div><h2><a class="anchor" name="2-upgrade-your-project-templates"></a>2. Upgrade your project templates <a class="hash-link" href="docs/upgrading.html#2-upgrade-your-project-templates">#</a></h2><p>The new npm package may contain updates to the files that are normally generated when you
|
||||
# where R is the <span class="token keyword">new</span> <span class="token class-name">version</span> of react from the peerDependency warning you saw</div><h3><a class="anchor" name="2-upgrade-your-project-templates"></a>2. Upgrade your project templates <a class="hash-link" href="docs/upgrading.html#2-upgrade-your-project-templates">#</a></h3><p>The new npm package may contain updates to the files that are normally generated when you
|
||||
run <code>react-native init</code>, like the iOS and the Android sub-projects.</p><p>You may consult <a href="https://github.com/ncuillery/rn-diff" target="_blank">rn-diff</a> to see if there were changes in the project template files.
|
||||
In case there weren't any, simply rebuild the project and continue developing. In case of minor changes, you may update your project manually and rebuild.</p><p>If there were major changes, run this in a terminal to get these:</p><div class="prism language-javascript">$ react<span class="token operator">-</span>native upgrade</div><p>This will check your files against the latest template and perform the following:</p><ul><li>If there is a new file in the template, it is simply created.</li><li>If a file in the template is identical to your file, it is skipped.</li><li>If a file is different in your project than the template, you will be prompted; you have options
|
||||
to view a diff between your file and the template file, keep your file or overwrite it with the
|
||||
template version. If you are unsure, press <code>h</code> to get a list of possible commands.</li></ul><h1><a class="anchor" name="manual-upgrades"></a>Manual Upgrades <a class="hash-link" href="docs/upgrading.html#manual-upgrades">#</a></h1><p>Some upgrades require manual steps, e.g. 0.13 to 0.14, or 0.28 to 0.29. Be sure to check the <a href="https://github.com/facebook/react-native/releases" target="_blank">release notes</a> when upgrading so that you can identify any manual changes your particular project may require.</p></div><div class="docs-prevnext"><a class="docs-prev" href="docs/understanding-cli.html#content">← Prev</a><a class="docs-next" href="docs/platform-specific-code.html#content">Next →</a></div><p class="edit-page-block">You can <a target="_blank" href="https://github.com/facebook/react-native/blob/master/docs/Upgrading.md">edit the content above on GitHub</a> and send us a pull request!</p></div></section><footer class="nav-footer"><section class="sitemap"><a href="/react-native" class="nav-home"><img src="img/header_logo.png" alt="React Native" width="66" height="58"></a><div><h5><a href="docs/">Docs</a></h5><a href="docs/getting-started.html">Getting Started</a><a href="docs/tutorial.html">Tutorial</a><a href="docs/integration-with-existing-apps.html">Integration With Existing Apps</a><a href="docs/more-resources.html">More Resources</a></div><div><h5><a href="/react-native/support.html">Community</a></h5><a href="/react-native/showcase.html">Showcase</a><a href="http://www.meetup.com/topics/react-native/" target="_blank">Upcoming Events</a><a href="https://www.facebook.com/groups/react.native.community" target="_blank">Facebook Group</a><a href="https://twitter.com/reactnative" target="_blank">Twitter</a></div><div><h5><a href="/react-native/support.html">Help</a></h5><a href="http://stackoverflow.com/questions/tagged/react-native" target="_blank">Stack Overflow</a><a href="https://discord.gg/0ZcbPKXt5bZjGY5n">Reactiflux Chat</a><a href="/react-native/versions.html" target="_blank">Latest Releases</a><a href="https://productpains.com/product/react-native/" target="_blank">Feature Requests</a></div><div><h5>More</h5><a href="/react-native/blog">Blog</a><a href="https://github.com/facebook/react-native" target="_blank">GitHub</a><a href="http://facebook.github.io/react/" target="_blank">React</a></div></section><section class="newsletter"><div id="mc_embed_signup"><form action="//reactnative.us10.list-manage.com/subscribe/post?u=db0dd948e2b729ee62625b1a8&id=47cd41008f" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate><div id="mc_embed_signup_scroll"><label for="mce-EMAIL"><h5>Get the React Native Newsletter</h5></label><input type="email" value="" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" required><div style="position:absolute;left:-5000px;" aria-hidden="true"><input type="text" name="b_db0dd948e2b729ee62625b1a8_47cd41008f" tabindex="-1" value=""></div><div class="clear"><input type="submit" value="Sign up" name="subscribe" id="mc-embedded-subscribe" class="button"></div></div></form></div></section><a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource"><img src="img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"></a><section class="copyright">Copyright © 2016 Facebook Inc.</section></footer></div><div id="fb-root"></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
|
||||
to keep your file or overwrite it with the template version.</li></ul><h1><a class="anchor" name="manual-upgrades"></a>Manual Upgrades <a class="hash-link" href="docs/upgrading.html#manual-upgrades">#</a></h1><p>Some upgrades require manual steps, e.g. 0.13 to 0.14, or 0.28 to 0.29. Be sure to check the <a href="https://github.com/facebook/react-native/releases" target="_blank">release notes</a> when upgrading so that you can identify any manual changes your particular project may require.</p></div><div class="docs-prevnext"><a class="docs-prev" href="docs/understanding-cli.html#content">← Prev</a><a class="docs-next" href="docs/platform-specific-code.html#content">Next →</a></div><p class="edit-page-block">You can <a target="_blank" href="https://github.com/facebook/react-native/blob/master/docs/Upgrading.md">edit the content above on GitHub</a> and send us a pull request!</p></div></section><footer class="nav-footer"><section class="sitemap"><a href="/react-native" class="nav-home"><img src="img/header_logo.png" alt="React Native" width="66" height="58"></a><div><h5><a href="docs/">Docs</a></h5><a href="docs/getting-started.html">Getting Started</a><a href="docs/tutorial.html">Tutorial</a><a href="docs/integration-with-existing-apps.html">Integration With Existing Apps</a><a href="docs/more-resources.html">More Resources</a></div><div><h5><a href="/react-native/support.html">Community</a></h5><a href="/react-native/showcase.html">Showcase</a><a href="http://www.meetup.com/topics/react-native/" target="_blank">Upcoming Events</a><a href="https://www.facebook.com/groups/react.native.community" target="_blank">Facebook Group</a><a href="https://twitter.com/reactnative" target="_blank">Twitter</a></div><div><h5><a href="/react-native/support.html">Help</a></h5><a href="http://stackoverflow.com/questions/tagged/react-native" target="_blank">Stack Overflow</a><a href="https://discord.gg/0ZcbPKXt5bZjGY5n">Reactiflux Chat</a><a href="/react-native/versions.html" target="_blank">Latest Releases</a><a href="https://productpains.com/product/react-native/" target="_blank">Feature Requests</a></div><div><h5>More</h5><a href="/react-native/blog">Blog</a><a href="https://github.com/facebook/react-native" target="_blank">GitHub</a><a href="http://facebook.github.io/react/" target="_blank">React</a></div></section><section class="newsletter"><div id="mc_embed_signup"><form action="//reactnative.us10.list-manage.com/subscribe/post?u=db0dd948e2b729ee62625b1a8&id=47cd41008f" method="post" id="mc-embedded-subscribe-form" name="mc-embedded-subscribe-form" class="validate" target="_blank" novalidate><div id="mc_embed_signup_scroll"><label for="mce-EMAIL"><h5>Get the React Native Newsletter</h5></label><input type="email" value="" name="EMAIL" class="email" id="mce-EMAIL" placeholder="email address" required><div style="position:absolute;left:-5000px;" aria-hidden="true"><input type="text" name="b_db0dd948e2b729ee62625b1a8_47cd41008f" tabindex="-1" value=""></div><div class="clear"><input type="submit" value="Sign up" name="subscribe" id="mc-embedded-subscribe" class="button"></div></div></form></div></section><a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource"><img src="img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"></a><section class="copyright">Copyright © 2016 Facebook Inc.</section></footer></div><div id="fb-root"></div><script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.js"></script><script>
|
||||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||||
|
||||
Reference in New Issue
Block a user