Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/facebook/react-native

A framework for building native applications using React
https://github.com/facebook/react-native

android app-framework cross-platform ios mobile mobile-development react react-native

Last synced: 25 days ago
JSON representation

A framework for building native applications using React

Awesome Lists containing this project

README 

        


  

    React Native

  






  Learn once, write anywhere:


  Build mobile apps with React.






  

    React Native is released under the MIT license.

  

  

    Current CircleCI build status.

  

  

    Current npm package version.

  

  

    PRs welcome!

  

  

    Follow @reactnative

  






  Getting Started

   ยท 

  Learn the Basics

   ยท 

  Showcase

   ยท 

  Contribute

   ยท 

  Community

   ยท 

  Support




React Native brings [**React**'s][r] declarative UI framework to iOS and Android. With React Native, you use native UI controls and have full access to the native platform.



- **Declarative.** React makes it painless to create interactive UIs. Declarative views make your code more predictable and easier to debug.

- **Component-Based.** Build encapsulated components that manage their state, then compose them to make complex UIs.

- **Developer Velocity.** See local changes in seconds. Changes to JavaScript code can be live reloaded without rebuilding the native app.

- **Portability.** Reuse code across iOS, Android, and [other platforms][p].



React Native is developed and supported by many companies and individual core contributors. Find out more in our [ecosystem overview][e].



[r]: https://react.dev/

[p]: https://reactnative.dev/docs/out-of-tree-platforms

[e]: https://github.com/facebook/react-native/blob/HEAD/ECOSYSTEM.md



## Contents



- [Requirements](#-requirements)

- [Building your first React Native app](#-building-your-first-react-native-app)

- [Documentation](#-documentation)

- [Upgrading](#-upgrading)

- [How to Contribute](#-how-to-contribute)

- [Code of Conduct](#code-of-conduct)

- [License](#-license)



## ๐Ÿ“‹ Requirements



React Native apps may target iOS 13.4 and Android 6.0 (API 23) or newer. You may use Windows, macOS, or Linux as your development operating system, though building and running iOS apps is limited to macOS. Tools like [Expo](https://expo.dev) can be used to work around this.



## ๐ŸŽ‰ Building your first React Native app



Follow the [Getting Started guide](https://reactnative.dev/docs/getting-started). 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][hello-world]

- [Creating a New Application][new-app]

- [Adding React Native to an Existing Application][existing]



[hello-world]: https://snack.expo.dev/@samples/hello-world

[new-app]: https://reactnative.dev/docs/getting-started

[existing]: https://reactnative.dev/docs/integration-with-existing-apps



## ๐Ÿ“– Documentation



The full documentation for React Native can be found on our [website][docs].



The React Native documentation discusses components, APIs, and topics that are specific to React Native. For further documentation on the React API that is shared between React Native and React DOM, refer to the [React documentation][r-docs].



The source for the React Native documentation and website is hosted on a separate repo, [**@facebook/react-native-website**][repo-website].



[docs]: https://reactnative.dev/docs/getting-started

[r-docs]: https://react.dev/learn

[repo-website]: https://github.com/facebook/react-native-website



## ๐Ÿš€ Upgrading



Upgrading to new versions of React Native may give you access to more APIs, views, developer tools, and other goodies. See the [Upgrading Guide][u] for instructions.



React Native releases are discussed [in this discussion repo](https://github.com/reactwg/react-native-releases/discussions).



[u]: https://reactnative.dev/docs/upgrading

[repo-releases]: https://github.com/react-native-community/react-native-releases



## ๐Ÿ‘ How to Contribute



The main purpose of this repository is to continue evolving React Native core. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving React Native.



### [Code of Conduct][code]



Facebook has adopted a Code of Conduct that we expect project participants to adhere to.

Please read the [full text][code] so that you can understand what actions will and will not be tolerated.



[code]: https://code.fb.com/codeofconduct/



### [Contributing Guide][contribute]



Read our [**Contributing Guide**][contribute] to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to React Native.



[contribute]: https://reactnative.dev/docs/contributing



### [Open Source Roadmap][roadmap]



You can learn more about our vision for React Native in the [**Roadmap**][roadmap].



[roadmap]: https://github.com/facebook/react-native/wiki/Roadmap



### Good First Issues



We have a list of [good first issues][gfi] that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.



[gfi]: https://github.com/facebook/react-native/labels/good%20first%20issue



### Discussions



Larger discussions and proposals are discussed in [**@react-native-community/discussions-and-proposals**][repo-meta].



[repo-meta]: https://github.com/react-native-community/discussions-and-proposals



## ๐Ÿ“„ License



React Native is MIT licensed, as found in the [LICENSE][l] file.



React Native documentation is Creative Commons licensed, as found in the [LICENSE-docs][ld] file.



[l]: https://github.com/facebook/react-native/blob/main/LICENSE

[ld]: https://github.com/facebook/react-native/blob/main/LICENSE-docs