A framework for building native apps with React. http://facebook.github.io/react-native/
Go to file
Michael Lee 48c27b9a6c Fix gradle build due to renamed boost directory
Reviewed By: yungsters

Differential Revision: D5033507

fbshipit-source-id: 1ab1126e0beb0a72f5a090a7cfeee0d5d99b0d16
2017-05-10 06:03:06 -07:00
.github Update ISSUE_TEMPLATE.md 2017-04-07 11:16:59 -07:00
ContainerShip Container Testing Updates 2017-04-12 16:31:35 -07:00
IntegrationTests Re-license and rename UIExplorer integration test app as RNTester 2017-05-08 11:31:19 -07:00
JSCLegacyProfiler Add suport for JSC profiling on iOS 9 2015-11-16 03:38:11 -08:00
Libraries ProgressBarAndroid checks indeterminate prop type manually 2017-05-10 05:16:06 -07:00
RNTester More attempts to fix Travis CI runs 2017-05-10 04:32:54 -07:00
React More attempts to fix Travis CI runs 2017-05-10 04:32:54 -07:00
ReactAndroid Fix gradle build due to renamed boost directory 2017-05-10 06:03:06 -07:00
ReactCommon log script name with bundle loading perf event 2017-05-10 04:09:19 -07:00
babel-preset Update babel-preset, filter path by identifiers. 2016-11-23 09:28:27 -08:00
blog Rename UIExplorer in docs 2017-05-08 11:31:21 -07:00
bots Code analysis bot does not need to comment on merge commits 2017-04-03 11:15:44 -07:00
docs Add info about inspecting instances to the docs 2017-05-09 12:01:49 -07:00
flow Fixes issues with uglify.js usage 2017-05-10 05:16:06 -07:00
gradle/wrapper Android - Update Gradle to 2.2.3 2017-01-31 13:13:32 -08:00
jest Stronger typing for transformers 2017-05-09 08:02:36 -07:00
keystores Apply auto-formatter for BUCK files in fbandroid. 2017-02-27 14:04:56 -08:00
lib Reorganize core JS files 2016-10-11 10:14:28 -07:00
local-cli packager: rename node-haste/index to DependencyGraph 2017-05-10 03:48:32 -07:00
packager packager: remove unused declareOpts module 2017-05-10 05:31:31 -07:00
react-native-cli Cast name to String to ensure .match is available 2017-02-17 20:01:43 -08:00
react-native-git-upgrade Fix react-native-git-upgrade cache busting 2017-02-18 16:45:50 -08:00
scripts More attempts to fix Travis CI runs 2017-05-10 04:32:54 -07:00
third-party-podspecs BREAKING - Update podspecs to support and default to the C++ bridge 2017-05-03 14:52:56 -07:00
website Add info about inspecting instances to the docs 2017-05-09 12:01:49 -07:00
.buckconfig Retry when maven download fails 2017-05-08 11:31:20 -07:00
.buckjavaargs limiting BUCK's memory for CI 2016-02-01 10:49:33 -08:00
.editorconfig Fix indent of .gradle files 2016-10-19 16:58:36 -07:00
.eslintignore packager: fork local version of worker-farm 2017-05-03 09:46:04 -07:00
.eslintrc XHR: support typed arrays for request payloads 2017-01-20 18:43:27 -08:00
.flowconfig Deploy v0.45.0 2017-04-27 17:20:46 -07:00
.gitattributes Added a .gitattributes file, ensuring that Bash script source files (gradlew and 2015-10-13 23:10:39 -04:00
.gitignore Native Animated - Restore, reorganize and add new tests 2017-03-27 11:46:05 -07:00
.npmignore Update .npmignore to include generated bundle file 2017-02-03 11:43:31 -08:00
.travis.yml Add a flag to support a simplified iOS test - just compile, don't run packager and tests 2017-03-16 15:19:02 -07:00
CONTRIBUTING.md Shorten template instructions. 2017-03-15 17:30:58 -07:00
DockerTests.md Docker Testing Environment for Android & JS 2017-02-24 10:59:53 -08:00
Jenkinsfile Container Testing Updates 2017-04-12 16:31:35 -07:00
LICENSE Update license 2015-03-23 10:48:39 -07:00
LICENSE-docs More licenses 2015-03-24 19:59:10 -07:00
PATENTS Update Patent Grant 2015-04-10 12:14:22 -07:00
README.md Re-license and rename UIExplorer integration test app as RNTester 2017-05-08 11:31:19 -07:00
React.podspec React.podspec fix for RCTAnimation header issue 2017-05-09 11:17:41 -07:00
Releases.md Support the --remote option in bump-oss-version.js script 2017-02-06 07:13:42 -08:00
Windows Fix tutorial link in README.md 2016-06-14 06:43:49 -07:00
breaking-changes.md DOCS ONLY: Update breaking changes location in breaking-changes.md: move to Wiki 2017-02-03 06:28:37 -08:00
build.gradle Update gradle-download-task from 2.0.0 to 3.1.2 to fix boost zip down… 2016-12-07 16:43:28 -08:00
circle.yml disable Circle e2e tests 2017-04-21 13:46:21 -07:00
cli.js packager: centralize babelRegisterOnly callsites 2017-01-06 06:13:54 -08:00
gradlew Update gradle wrapper binary and scripts 2016-09-09 08:13:59 -07:00
gradlew.bat Update gradle wrapper binary and scripts 2016-09-09 08:13:59 -07:00
jest-preset.json Add missing slash. 2016-12-07 20:58:30 -08:00
package.json packager: remove unused declareOpts module 2017-05-10 05:31:31 -07:00
react.gradle Add ability to customize CLI path 2017-04-10 12:16:03 -07:00
rn-cli.config.js Add a local packager config, so that react can find react-native when… 2016-07-05 10:28:24 -07:00
runXcodeTests.sh Re-license and rename UIExplorer integration test app as RNTester 2017-05-08 11:31:19 -07:00
settings.gradle Re-license and rename UIExplorer integration test app as RNTester 2017-05-08 11:31:19 -07:00
setupBabel.js Remove `react-packager` indirection. 2017-02-02 05:44:15 -08:00

README.md

React Native Build Status Circle CI npm version

React Native enables you to build world-class application experiences on native platforms using a consistent developer experience based on JavaScript and React. The focus of React Native is on developer efficiency across all the platforms you care about - learn once, write anywhere. Facebook uses React Native in multiple production apps and will continue investing in React Native.

Supported operating systems are >= Android 4.1 (API 16) and >= iOS 8.0.

Introduction

See the official React Native website for an introduction to React Native.

Getting Started

Getting Help

Please use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.

  • Ask a question on StackOverflow and tag it with react-native
  • Chat with us on Reactiflux in #react-native
  • Articulate your feature request or upvote existing ones on Canny
  • Start a thread on the React Discussion Board
  • Join #reactnative on IRC: chat.freenode.net
  • If it turns out that you may have found a bug, please open an issue

Documentation

The websites documentation is divided into multiple sections.

Another great way to learn more about the components and APIs included with React Native is to read their source. Look under the Libraries directory for components like ScrollView and Navigator, for example. The RNTester example is also here to demonstrate some of the ways to use these components. From the source you can get an accurate understanding of each components behavior and API.

The React Native documentation only discusses the components, APIs and topics specific to React Native (React on iOS and Android). For further documentation on the React API that is shared between React Native and React DOM, refer to the React documentation.

Examples

  • git clone https://github.com/facebook/react-native.git
  • cd react-native && npm install

Running the examples on iOS

Now open any example (the .xcodeproj file in each of the Examples subdirectories) and hit Run in Xcode.

Running the examples on Android

Note that you'll need the Android NDK installed, see prerequisites.

./gradlew :Examples:Movies:android:app:installDebug
# Start the packager in a separate shell (make sure you ran npm install):
./packager/packager.sh
# Open the Movies app in your emulator

Extending React Native

  • Looking for a component? JS.coach
  • Fellow developers write and publish React Native modules to npm and open source them on GitHub.
  • Making modules helps grow the React Native ecosystem and community. We recommend writing modules for your use cases and sharing them on npm.
  • Read the guides on Native Modules (iOS, Android) and Native UI Components (iOS, Android) if you are interested in extending native functionality.

Upgrading

React Native is under active development. See the guide on upgrading React Native to keep your project up-to-date.

Opening Issues

If you encounter a bug with React Native we would like to hear about it. Search the existing issues and try to make sure your problem doesnt already exist before opening a new issue. Its helpful if you include the version of React Native and OS youre using. Please include a stack trace and reduced repro case when appropriate, too.

The GitHub issues are intended for bug reports and feature requests. For help and questions with using React Native please make use of the resources listed in the Getting Help section. Canny in particular is a good way to signal your interest in a feature or issue. There are limited resources available for handling issues and by keeping the list of open issues lean we can respond in a timely manner.

Contributing

For more information about contributing PRs and issues, see our Contribution Guidelines.

Good First Task is a great starting point for PRs.

We encourage the community to ask and answer questions on Stack Overflow with the react-native tag. It's a great way to help out and be involved!

License

React is BSD licensed. We also provide an additional patent grant.

React documentation is Creative Commons licensed.

Examples provided in this repository and in the documentation are separately licensed, as are some of the custom components.