UNPKG

6.83 kBMarkdownView Raw
1<h1 align="center">
2 <a href="https://reactnative.dev/">
3 React Native
4 </a>
5</h1>
6
7<p align="center">
8 <strong>Learn once, write anywhere:</strong><br>
9 Build mobile apps with React.
10</p>
11
12<p align="center">
13 <a href="https://github.com/facebook/react-native/blob/HEAD/LICENSE">
14 <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="React Native is released under the MIT license." />
15 </a>
16 <a href="https://circleci.com/gh/facebook/react-native">
17 <img src="https://circleci.com/gh/facebook/react-native.svg?style=shield" alt="Current CircleCI build status." />
18 </a>
19 <a href="https://www.npmjs.org/package/react-native">
20 <img src="https://img.shields.io/npm/v/react-native?color=brightgreen&label=npm%20package" alt="Current npm package version." />
21 </a>
22 <a href="https://reactnative.dev/docs/contributing">
23 <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
24 </a>
25 <a href="https://twitter.com/intent/follow?screen_name=reactnative">
26 <img src="https://img.shields.io/twitter/follow/reactnative.svg?label=Follow%20@reactnative" alt="Follow @reactnative" />
27 </a>
28</p>
29
30<h3 align="center">
31 <a href="https://reactnative.dev/docs/getting-started">Getting Started</a>
32 <span> · </span>
33 <a href="https://reactnative.dev/docs/tutorial">Learn the Basics</a>
34 <span> · </span>
35 <a href="https://reactnative.dev/showcase">Showcase</a>
36 <span> · </span>
37 <a href="https://reactnative.dev/docs/contributing">Contribute</a>
38 <span> · </span>
39 <a href="https://reactnative.dev/help">Community</a>
40 <span> · </span>
41 <a href="https://github.com/facebook/react-native/blob/HEAD/.github/SUPPORT.md">Support</a>
42</h3>
43
44React 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.
45
46- **Declarative.** React makes it painless to create interactive UIs. Declarative views make your code more predictable and easier to debug.
47- **Component-Based.** Build encapsulated components that manage their state, then compose them to make complex UIs.
48- **Developer Velocity.** See local changes in seconds. Changes to JavaScript code can be live reloaded without rebuilding the native app.
49- **Portability.** Reuse code across iOS, Android, and [other platforms][p].
50
51React Native is developed and supported by many companies and individual core contributors. Find out more in our [ecosystem overview][e].
52
53[r]: https://react.dev/
54[p]: https://reactnative.dev/docs/out-of-tree-platforms
55[e]: https://github.com/facebook/react-native/blob/HEAD/ECOSYSTEM.md
56
57## Contents
58
59- [Requirements](#-requirements)
60- [Building your first React Native app](#-building-your-first-react-native-app)
61- [Documentation](#-documentation)
62- [Upgrading](#-upgrading)
63- [How to Contribute](#-how-to-contribute)
64- [Code of Conduct](#code-of-conduct)
65- [License](#-license)
66
67
68## 📋 Requirements
69
70React Native apps may target iOS 13.4 and Android 5.0 (API 21) 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.
71
72## 🎉 Building your first React Native app
73
74Follow 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:
75
76- [Trying out React Native][hello-world]
77- [Creating a New Application][new-app]
78- [Adding React Native to an Existing Application][existing]
79
80[hello-world]: https://snack.expo.dev/@samples/hello-world
81[new-app]: https://reactnative.dev/docs/getting-started
82[existing]: https://reactnative.dev/docs/integration-with-existing-apps
83
84## 📖 Documentation
85
86The full documentation for React Native can be found on our [website][docs].
87
88The 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].
89
90The source for the React Native documentation and website is hosted on a separate repo, [**@facebook/react-native-website**][repo-website].
91
92[docs]: https://reactnative.dev/docs/getting-started
93[r-docs]: https://react.dev/learn
94[repo-website]: https://github.com/facebook/react-native-website
95
96## 🚀 Upgrading
97
98Upgrading 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.
99
100React Native releases are discussed [in this discussion repo](https://github.com/reactwg/react-native-releases/discussions).
101
102[u]: https://reactnative.dev/docs/upgrading
103[repo-releases]: https://github.com/react-native-community/react-native-releases
104
105## 👏 How to Contribute
106
107The 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.
108
109### [Code of Conduct][code]
110
111Facebook has adopted a Code of Conduct that we expect project participants to adhere to.
112Please read the [full text][code] so that you can understand what actions will and will not be tolerated.
113
114[code]: https://code.fb.com/codeofconduct/
115
116### [Contributing Guide][contribute]
117
118Read 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.
119
120[contribute]: https://reactnative.dev/docs/contributing
121
122### [Open Source Roadmap][roadmap]
123
124You can learn more about our vision for React Native in the [**Roadmap**][roadmap].
125
126[roadmap]: https://github.com/facebook/react-native/wiki/Roadmap
127
128### Good First Issues
129
130We 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.
131
132[gfi]: https://github.com/facebook/react-native/labels/good%20first%20issue
133
134### Discussions
135
136Larger discussions and proposals are discussed in [**@react-native-community/discussions-and-proposals**][repo-meta].
137
138[repo-meta]: https://github.com/react-native-community/discussions-and-proposals
139
140## 📄 License
141
142React Native is MIT licensed, as found in the [LICENSE][l] file.
143
144React Native documentation is Creative Commons licensed, as found in the [LICENSE-docs][ld] file.
145
146[l]: https://github.com/facebook/react-native/blob/main/LICENSE
147[ld]: https://github.com/facebook/react-native/blob/main/LICENSE-docs