react-native/docs/GettingStarted.md

---
id: getting-started
title: Getting Started
layout: docs
category: Quick Start
permalink: docs/getting-started.html
next: tutorial
---

## Requirements

1. OS X - This repo only contains the iOS (7+) implementation right now, and Xcode only runs on Mac.
2. [Xcode](https://developer.apple.com/xcode/downloads/) 6.3 or higher is recommended.
3. [Homebrew](http://brew.sh/) is the recommended way to install io.js, watchman, and flow.
4. Install [io.js](https://iojs.org/) 1.0 or newer. io.js is the modern version of Node.
  - Install **nvm** with [its setup instructions here](https://github.com/creationix/nvm#installation). Then run `nvm install iojs-v2 && nvm alias default iojs-v2`, which installs the latest compatible version of io.js and sets up your terminal so that typing `node` runs io.js. With nvm you can install multiple versions of Node and io.js and easily switch between them.
  - New to [npm](https://docs.npmjs.com/)?
5. `brew install watchman`. We recommend installing [watchman](https://facebook.github.io/watchman/docs/install.html), otherwise you might hit a node file watching bug.
6. `brew install flow`. If you want to use [flow](http://www.flowtype.org).

We recommend periodically running `brew update && brew upgrade` to keep your programs up-to-date.

## Quick start

- `npm install -g react-native-cli`
- `react-native init AwesomeProject`

In the newly created folder `AwesomeProject/`

- Open `AwesomeProject.xcodeproj` and hit run in Xcode.
- Open `index.ios.js` in your text editor of choice and edit some lines.
- Hit cmd+R in your iOS simulator to reload the app and see your change!

Congratulations! You've just successfully run and modified your first React Native app.

_If you run into any issues getting started, see the [troubleshooting page](/react-native/docs/troubleshooting.html#content)._
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`
Add Tutorial.md 2015-03-25 09:08:09 +00:00			`next: tutorial`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00			`---`

			`## Requirements`

[Docs] Add supported iOS version to getting started 2015-05-30 22:09:32 +00:00			`1. OS X - This repo only contains the iOS (7+) implementation right now, and Xcode only runs on Mac.`
[Docs] Xcode has a lower-case c 2015-06-02 21:06:30 +00:00			`2. [Xcode](https://developer.apple.com/xcode/downloads/) 6.3 or higher is recommended.`
[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			`3. [Homebrew](http://brew.sh/) is the recommended way to install io.js, watchman, and flow.`
			`4. Install [io.js](https://iojs.org/) 1.0 or newer. io.js is the modern version of Node.`
[docs] remove instructions to install node/io.js with brew nvm is way better than homebrew for managing node installations: - can install multiple versions - can choose which version of node to install - easy to clean up under ~/.nvm - there are still some rough edges with /usr/local on El Cap -- nvm avoids those altogether 2015-08-10 21:31:48 +00:00			- Install nvm with [its setup instructions here](https://github.com/creationix/nvm#installation). Then run `nvm install iojs-v2 && nvm alias default iojs-v2`, which installs the latest compatible version of io.js and sets up your terminal so that typing `node` runs io.js. With nvm you can install multiple versions of Node and io.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/)?`
Watchman released 3.1 (no need for `--HEAD` install) 2015-04-21 00:34:59 +00:00			5. `brew install watchman`. We recommend installing [watchman](https://facebook.github.io/watchman/docs/install.html), otherwise you might hit a node file watching bug.
Make GettingStarted shorter and up to date 2015-03-25 19:56:31 +00:00			6. `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.

Initial version of the website and docs. 2015-02-12 04:26:43 +00:00			`## Quick start`

Make GettingStarted shorter and up to date 2015-03-25 19:56:31 +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
Make GettingStarted shorter and up to date 2015-03-25 19:56:31 +00:00			In the newly created folder `AwesomeProject/`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00
Update GettingStarted.md Add missing full stops. 2015-04-22 02:45:38 +00:00			- Open `AwesomeProject.xcodeproj` and hit run in Xcode.
			- Open `index.ios.js` in your text editor of choice and edit some lines.
Remove Twice for Cmd+R 2015-04-08 16:26:17 +00:00			`- Hit cmd+R in your iOS simulator to reload the app and see your change!`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00
Make GettingStarted shorter and up to date 2015-03-25 19:56:31 +00:00			`Congratulations! You've just successfully run and modified your first React Native app.`
Initial version of the website and docs. 2015-02-12 04:26:43 +00:00
Add '#content' to link 2015-03-30 20:09:11 +00:00			`_If you run into any issues getting started, see the [troubleshooting page](/react-native/docs/troubleshooting.html#content)._`