status-im
/
react-native
mirror of https://github.com/status-im/react-native.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
react-native/docs/GettingStarted.md

67 lines
3.2 KiB
Markdown
Raw Normal View History

Initial version of the website and docs.
2015-02-12 04:26:43 +00:00
---
id: getting-started
title: Getting Started
layout: docs
category: Quick Start
permalink: docs/getting-started.html
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
next: android-setup
Initial version of the website and docs.
2015-02-12 04:26:43 +00:00
---
## Requirements
[docs] Add docs about Linux and Windows support
2015-10-21 13:02:27 +00:00
1. OS X - This guide assumes OS X which is needed for iOS development.
[Docs] Remove recommendation to install nvm from brew The nvm maintainers have their own recommended installation instructions (via shell script or git checkout), which are linked to from the docs.
2015-09-25 20:18:31 +00:00
2. [Homebrew](http://brew.sh/) is the recommended way to install Watchman and Flow.
[Docs] Update RN website docs to mention Node 4+ instead of io.js The io.js codebase has been rebranded as "Node.js", so moving forward everyone should install the latest version of Node. The name "io.js" is no longer.
2015-09-03 22:29:46 +00:00
3. Install [Node.js](https://nodejs.org/) 4.0 or newer.
[Docs] Remove recommendation to install nvm from brew The nvm maintainers have their own recommended installation instructions (via shell script or git checkout), which are linked to from the docs.
2015-09-25 20:18:31 +00:00
- Install **nvm** with [its setup instructions here](https://github.com/creationix/nvm#installation). Then run `nvm install node && nvm alias default node`, which installs the latest version of Node.js and sets up your terminal so you can run it by typing `node`. With nvm you can install multiple versions of Node.js and easily switch between them.
[Docs] Explain more about nvm in the io.js setup docs Clarify that io.js is the modern version of Node and explain a little more about how to get set up with nvm, and that it lets you switch between multiple io.js/node versions.
2015-07-30 00:29:18 +00:00
- New to [npm](https://docs.npmjs.com/)?
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
4. `brew install watchman`. We recommend installing [watchman](https://facebook.github.io/watchman/docs/install.html), otherwise you might hit a node file watching bug.
Fix tiny grammatical error
2015-09-17 20:11:55 +00:00
5. `brew install flow`, if you want to use [flow](http://www.flowtype.org).
Initial version of the website and docs.
2015-02-12 04:26:43 +00:00
[Docs] Explain more about nvm in the io.js setup docs Clarify that io.js is the modern version of Node and explain a little more about how to get set up with nvm, and that it lets you switch between multiple io.js/node versions.
2015-07-30 00:29:18 +00:00
We recommend periodically running `brew update && brew upgrade` to keep your programs up-to-date.
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
## iOS Setup
Requires Xcode 7 or higher to run 0.15.0-rc
2015-11-18 01:09:09 +00:00
[Xcode](https://developer.apple.com/xcode/downloads/) 7.0 or higher is required. It can be installed from the App Store.
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
## Android Setup
fixed a link to android setup docs Reviewed By: svcscm Differential Revision: D2936714 fb-gh-sync-id: fe97ee55cb5bf5ba736e0e5aa64462e5893a77c8 shipit-source-id: fe97ee55cb5bf5ba736e0e5aa64462e5893a77c8
2016-02-14 17:39:52 +00:00
To write React Native apps for Android, you will need to install the Android SDK (and an Android emulator if you want to work on your app without having to use a physical device). See [Android setup guide](docs/android-setup.html) for instructions on how to set up your Android environment.
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
CI now builds docs website and deploys it to /%version% path Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes https://github.com/facebook/react-native/pull/5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
2016-02-11 14:16:34 +00:00
_NOTE:_ There is experimental [Windows and Linux support](docs/linux-windows-support.html) for Android development.
[docs] Add docs about Linux and Windows support
2015-10-21 13:02:27 +00:00
Initial version of the website and docs.
2015-02-12 04:26:43 +00:00
## Quick start
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
$ npm install -g react-native-cli
$ react-native init AwesomeProject
Initial version of the website and docs.
2015-02-12 04:26:43 +00:00
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
**To run the iOS app:**
Initial version of the website and docs.
2015-02-12 04:26:43 +00:00
Update GettingStarted.md
2015-09-24 14:18:42 +00:00
- `$ cd AwesomeProject`
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
- Open `ios/AwesomeProject.xcodeproj` and hit run in Xcode.
Update GettingStarted.md Add missing full stops.
2015-04-22 02:45:38 +00:00
- Open `index.ios.js` in your text editor of choice and edit some lines.
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
- Hit ⌘-R in your iOS simulator to reload the app and see your change!
CI now builds docs website and deploys it to /%version% path Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes https://github.com/facebook/react-native/pull/5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
2016-02-11 14:16:34 +00:00
_Note: If you are using an iOS device, see the [Running on iOS Device page](docs/running-on-device-ios.html#content)._
Link to iOS device docs Spent an hour trying to find this doc. Hope this helps the next person!
2016-01-08 22:15:33 +00:00
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
**To run the Android app:**
Update GettingStarted.md
2015-09-24 14:18:42 +00:00
- `$ cd AwesomeProject`
- `$ react-native run-android`
- Open `index.android.js` in your text editor of choice and edit some lines.
- Press the menu button (F2 by default, or ⌘-M in Genymotion) and select *Reload JS* to see your change!
- Run `adb logcat *:S ReactNative:V ReactNativeJS:V` in a terminal to see your app's logs
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
CI now builds docs website and deploys it to /%version% path Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes https://github.com/facebook/react-native/pull/5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
2016-02-11 14:16:34 +00:00
_Note: If you are using an Android device, see the [Running on Android Device page](docs/running-on-device-android.html#content)._
[Docs][Android] Adds "Running on Device" note Lots of people keep asking why they get a red screen telling them to connect to a dev server when using their device. Most have followed the "Getting Started" guide, but didn't notice the "Running on Device" section since it is kinda buried in the sidebar and isn't linked to from anywhere.
2015-09-15 22:09:32 +00:00
[Docs] xcodeproj for new projects is now in iOS/
2015-09-10 04:08:58 +00:00
Congratulations! You've successfully run and modified your first React Native app.
Initial version of the website and docs.
2015-02-12 04:26:43 +00:00
CI now builds docs website and deploys it to /%version% path Summary: Copy of #5760 reverted merge. We need to preserve history of docs changes on the webserver. The goal is to allow users to browse outdated versions of docs. To make things simple all websites will be released to https://facebook.github.io/react-native/releases/version/XX folder when there is a branch cut. I switched from Travis CI to Cirle CI because it works faster and I am more familiar with it. How it works: 1. If code is pushed to `master` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/next folder. Github will serve this website from https://facebook.github.io/react-native/releases/version/next URL. All relative URLs will work within that website 2. If code is pushed to `0.20-stable` branch then CI will build a fresh version of docs and put it in https://github.com/facebook/react-native/tree/gh-pages/releases/0.20 folder. Github will serve this website from https://facebook.github.io/react-native/releases/v Closes https://github.com/facebook/react-native/pull/5873 Reviewed By: svcscm Differential Revision: D2926901 Pulled By: androidtrunkagent fb-gh-sync-id: 16aea430bac815933d9c603f03921cc6353906f1 shipit-source-id: 16aea430bac815933d9c603f03921cc6353906f1
2016-02-11 14:16:34 +00:00
_If you run into any issues getting started, see the [troubleshooting page](docs/troubleshooting.html#content)._
Release React Native for Android This is an early release and there are several things that are known not to work if you're porting your iOS app to Android. See the Known Issues guide on the website. We will work with the community to reach platform parity with iOS.
2015-09-14 14:35:58 +00:00
## Adding Android to an existing React Native project
If you already have a (iOS-only) React Native project and want to add Android support, you need to execute the following commands in your existing project directory:
1. Update the `react-native` dependency in your `package.json` file to [the latest version](https://www.npmjs.com/package/react-native)
2. `$ npm install`
3. `$ react-native android`