react-native/docs/GettingStarted.md
Robert Ing b577573730 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 16:57:33 -05:00

32 lines
1.2 KiB
Markdown

---
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 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 ([twice](http://openradar.appspot.com/19613391)) 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.