A framework for building native apps with React. http://facebook.github.io/react-native/
Go to file
Christoph Pojer 29d9c35e12 Add --maxWorkers flag and allow transformers to run in-band.
Summary:
This diff cleans up some cruft and adds some features:

* It removes the usage of an env variable to control workers.
* It removes the lazy and handwavy calculation on how many workers to use for jest-haste-map. Jest itself uses the maximum amount of workers available and it has never been reported as an issue – especially since it is a one-time startup cost of about 3 seconds on a cold cache only.
* It adds a `--max-workers` flag to replace the env variable. This one is able to control both the number of workers for `jest-haste-map` as well as the transformers.
* It makes the transformers run in the parent process if 1 or fewer workers are are specified. This should help with debugging.

Once you approve this diff, I will publish a new version of metro to npm and update the version used in RN and remove the use of the env variable altogether: https://our.intern.facebook.com/intern/biggrep/?corpus=xplat&filename=&case=false&view=default&extre=&s=REACT_NATIVE_MAX_WORKERS&engine=apr_strmatch&context=false&filter[uninteresting]=false&filter[intern]=false&filter[test]=false&grep_regex=

Note: the process of adding a CLI option is really broken. Commander also has a weird API. We should consider building a better public API for Metro and then consider how to build a new CLI on top of it and simplify our internal integration. I really don't like how Metro is integrated across pieces of the RN cli in ways that is hard to manage. But that is a larger task for another time :)

Reviewed By: jeanlauliac

Differential Revision: D5217726

fbshipit-source-id: 74efddbb87755a9e744c816fbc62efa21f6a79bf
2017-06-13 09:16:03 -07:00
.github Update ISSUE_TEMPLATE.md 2017-06-01 15:02:04 -07:00
ContainerShip Add --maxWorkers flag and allow transformers to run in-band. 2017-06-13 09:16:03 -07:00
IntegrationTests Fix react-native function call arity errors 2017-05-18 16:55:55 -07:00
JSCLegacyProfiler Add suport for JSC profiling on iOS 9 2015-11-16 03:38:11 -08:00
Libraries Native Animated - Call x.__makeNative before super.__makeNative 2017-06-13 08:45:42 -07:00
RNTester Add inverted option 2017-06-12 22:45:49 -07:00
React add marker surrounding entire native module creation 2017-06-09 06:22:39 -07:00
ReactAndroid Stop requiring registration of callable JS modules 2017-06-13 05:46:31 -07:00
ReactCommon Rounding error in width/height fixed 2017-06-10 05:35:55 -07:00
babel-preset Enable JSX source plugin in DEV and integrate it with React DevTools 2017-05-12 08:50:11 -07: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 documentation for supporting custom require types 2017-06-12 13:32:20 -07:00
flow Move type definitions used for metro bundler from React Native 2017-06-09 14:02:05 -07:00
gradle/wrapper Android - Update Gradle to 2.2.3 2017-01-31 13:13:32 -08:00
jest Remove react-native/packager folder. 2017-06-07 07:30:32 -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 Add --maxWorkers flag and allow transformers to run in-band. 2017-06-13 09:16:03 -07:00
react-native-cli Fail gracefully for node<4 in react-native-cli (const->var) 2017-06-06 11:20:47 -07:00
react-native-git-upgrade Fix react-native-git-upgrade cache busting 2017-02-18 16:45:50 -08:00
scripts Add --maxWorkers flag and allow transformers to run in-band. 2017-06-13 09:16:03 -07:00
third-party-podspecs Fix some issues with the React podspec for the Cxx bridge 2017-05-30 11:15:19 -07:00
website New Handling Touches Tutorial 2017-06-07 11:51:21 -07:00
.buckconfig update gitignore & fix links 2017-05-22 13:03:50 -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 Flat ReactNative renderer bundle [WIP] 2017-05-26 11:03:06 -07:00
.gitattributes Added a .gitattributes file, ensuring that Bash script source files (gradlew and 2015-10-13 23:10:39 -04:00
.gitignore update gitignore & fix links 2017-05-22 13:03:50 -07:00
.npmignore Update .npmignore to include generated bundle file 2017-02-03 11:43:31 -08:00
.travis.yml Fix Travis CI runs 2017-06-02 09:03:18 -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 Replace Navigator references to with existing components 2017-05-30 12:01:38 -07:00
React.podspec Fix some issues with the React podspec for the Cxx bridge 2017-05-30 11:15:19 -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 Add --maxWorkers flag and allow transformers to run in-band. 2017-06-13 09:16:03 -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 Add --maxWorkers flag and allow transformers to run in-band. 2017-06-13 09:16:03 -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 metro-bundler: make internal tool to use the new source of thruth for packager/metro-bundler 2017-06-06 05:15:51 -07: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/Components directory for components like ScrollView and TextInput, 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 RNTester app on iOS

Now open RNTester/RNTester.xcodeproj and hit Run in Xcode.

Running the RNTester app on Android

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

./gradlew :RNTester:android:app:installDebug
# Start the packager in a separate shell (make sure you ran npm install):
./scripts/packager.sh

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.