react-native/docs/GettingStarted.md

33 lines
1.3 KiB
Markdown
Raw Normal View History

---
id: getting-started
title: Getting Started
layout: docs
category: Quick Start
permalink: docs/getting-started.html
2015-03-25 09:08:09 +00:00
next: tutorial
---
## Requirements
1. OS X - This repo only contains the iOS (7+) implementation right now, and Xcode only runs on Mac.
2015-06-02 21:06:30 +00:00
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 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.
2015-04-08 16:26:17 +00:00
- 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.
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)._