UNPKG

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