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 implementation right now, and Xcode only runs on Mac.
2. New to Xcode?  [Download it](https://developer.apple.com/xcode/downloads/) from the Mac App Store.
3. [Homebrew](http://brew.sh/) is the recommended way to install node, watchman, and flow.
4. `brew install node`. New to [node](https://nodejs.org/) or [npm](https://docs.npmjs.com/)?
5. `brew install --HEAD 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).

## 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`

			`1. OS X - This repo only contains the iOS implementation right now, and Xcode only runs on Mac.`
			`2. New to Xcode? [Download it](https://developer.apple.com/xcode/downloads/) from the Mac App Store.`
			`3. [Homebrew](http://brew.sh/) is the recommended way to install node, watchman, and flow.`
Add links to node and npm in Requirements In getting started, it asks if you are new to node and npm, but there are no links to explain what either is. I believe these links help to clarify. 2015-03-26 21:57:33 +00:00			4. `brew install node`. New to [node](https://nodejs.org/) or [npm](https://docs.npmjs.com/)?
(update) Install watchman w/ --HEAD to avoid error Updated the docs for installing watchman with --HEAD per @wez suggestion in this issue thread https://github.com/facebook/react-native/issues/239 2015-04-02 22:04:05 +00:00			5. `brew install --HEAD 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
			`## 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
Make GettingStarted shorter and up to date 2015-03-25 19:56:31 +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)._`