mirror of
https://github.com/facebook/react-native.git
synced 2024-11-22 06:29:46 +00:00
c355a34de1
Summary: <!-- Thank you for sending the PR! We appreciate you spending the time to work on these changes. Help us understand your motivation by explaining why you decided to make this change. You can learn more about contributing to React Native here: http://facebook.github.io/react-native/docs/contributing.html Happy contributing! --> While I was reading README I found wrong links to `beginner friendly issues` so just fixed them. Closes https://github.com/facebook/react-native/pull/17579 Differential Revision: D6719845 Pulled By: shergin fbshipit-source-id: 5c3290f70efbd8c40c2d3482c23c198ab45d510e
82 lines
5.9 KiB
Markdown
82 lines
5.9 KiB
Markdown
# [React Native](https://facebook.github.io/react-native/) · [](https://circleci.com/gh/facebook/react-native) [](https://badge.fury.io/js/react-native) [](CONTRIBUTING.md#pull-requests)
|
||
|
||
Learn once, write anywhere: Build mobile apps with React.
|
||
|
||
- **Build native mobile apps using JavaScript and React:** React Native lets you build mobile apps using only JavaScript. It uses the same design as [React](https://facebook.github.io/react), letting you compose a rich mobile UI from declarative components.
|
||
- **A React Native app is a real mobile app:** With React Native, you don't build a "mobile web app", an "HTML5 app", or a "hybrid app". You build a real mobile app that's indistinguishable from an app built using Objective-C, Java, or Swift. React Native uses the same fundamental UI building blocks as regular iOS and Android apps. You just put those building blocks together using JavaScript and React.
|
||
- **Don't waste time recompiling:** React Native lets you build your app faster. Instead of recompiling, you can reload your app instantly. With hot reloading, you can even run new code while retaining your application state. Give it a try - it's a magical experience.
|
||
- **Use native code when you need to:** React Native combines smoothly with components written in Objective-C, Java, or Swift. It's simple to drop down to native code if you need to optimize a few aspects of your application. It's also easy to build part of your app in React Native, and part of your app using native code directly - that's how the Facebook app works.
|
||
|
||
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.
|
||
|
||
See the official [React Native website](https://facebook.github.io/react-native/) for an introduction to React Native.
|
||
|
||
Supported operating systems are >= Android 4.1 (API 16) and >= iOS 8.0.
|
||
|
||
- [Getting Started](#getting-started)
|
||
- [Getting Help](#getting-help)
|
||
- [Documentation](#documentation)
|
||
- [Upgrading](#upgrading)
|
||
- [Contributing](#contributing)
|
||
- [License](#license)
|
||
|
||
---
|
||
|
||
## Getting Started
|
||
|
||
Follow the [Getting Started guide](https://facebook.github.io/react-native/docs/getting-started.html). The recommended way to install React Native depends on your project. Here you can find short guides for the most common scenarios:
|
||
|
||
- [Trying out React Native](https://snack.expo.io/BJ-uC-nrb)
|
||
- [Creating a New Application](https://facebook.github.io/react-native/docs/getting-started.html)
|
||
- [Adding React Native to an Existing Application](https://facebook.github.io/react-native/docs/integration-with-existing-apps.html)
|
||
|
||
---
|
||
|
||
## Documentation
|
||
|
||
[The website’s documentation](https://facebook.github.io/react-native/docs/getting-started.html) is divided into multiple sections.
|
||
- There are **Guides** that discuss topics like [debugging](https://facebook.github.io/react-native/docs/debugging.html), [integrating with existing apps](https://facebook.github.io/react-native/docs/integration-with-existing-apps.html), and [the gesture responder system](https://facebook.github.io/react-native/docs/gesture-responder-system.html).
|
||
- The **Components** section covers React components such as [`View`](https://facebook.github.io/react-native/docs/view.html) and [`Button`](https://facebook.github.io/react-native/docs/button.html).
|
||
- The **APIs** section covers other libraries like [Animated](https://facebook.github.io/react-native/docs/animated.html) and [StyleSheet](https://facebook.github.io/react-native/docs/stylesheet.html) that aren’t React components themselves.
|
||
- Finally, React Native provides a small number of **Polyfills** that offer web-like APIs.
|
||
|
||
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 component’s 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](https://facebook.github.io/react/).
|
||
|
||
---
|
||
|
||
## Upgrading
|
||
|
||
React Native is under active development. See the guide on [upgrading React Native](https://facebook.github.io/react-native/docs/upgrading.html) to keep your project up-to-date.
|
||
|
||
---
|
||
|
||
## Contributing
|
||
|
||
Read below to learn how you can take part in improving React Native.
|
||
|
||
### [Code of Conduct](https://code.facebook.com/codeofconduct)
|
||
|
||
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
|
||
|
||
### Contributing Guide
|
||
|
||
Read our [contributing guide](https://facebook.github.io/react-native/docs/contributing.html) to learn about our development process, how to propose bug fixes and improvements, and how to build and test your changes to React Native.
|
||
|
||
### Beginner Friendly Bugs
|
||
|
||
We have a list of [beginner friendly issues](https://github.com/facebook/react-native/labels/Good%20first%20issue) to help you get your feet wet in the React Native codebase and familiar with our contribution process. This is a great place to get started.
|
||
|
||
---
|
||
|
||
## License
|
||
|
||
React Native is [BSD licensed](./LICENSE). We also provide an additional [patent grant](./PATENTS).
|
||
|
||
React Native documentation is [Creative Commons licensed](./LICENSE-docs).
|
||
|
||
---
|
||
|
||
<img src="https://avatars2.githubusercontent.com/u/69631?s=200&v=4" width="50"></img>
|