|
| 1 | +<h1 align="center"> React Native for macOS </h1> |
| 2 | + |
| 3 | +<p align="center"> |
| 4 | + Build native macOS apps with React. |
| 5 | +</p> |
| 6 | + |
| 7 | +<p align="center"> |
| 8 | + <a href="https://github.com/microsoft/react-native-macos/blob/master/LICENSE"> |
| 9 | + <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="React Native for macOS is released under the MIT license." /> |
| 10 | + </a> |
| 11 | + <a href="https://www.npmjs.org/package/react-native-macos"> |
| 12 | + <img src="https://img.shields.io/npm/v/react-native-macos?color=e80441&label=react-native-macos" alt="Current npm package version." /> |
| 13 | + </a> |
| 14 | + <a href="https://github.com/microsoft/react-native-macos/blob/master/CONTRIBUTING.md"> |
| 15 | + <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" /> |
| 16 | + </a> |
| 17 | +</p> |
| 18 | + |
| 19 | +> See the official [React Native website](https://reactnative.dev/) for an introduction to React Native. |
| 20 | +
|
| 21 | +[React Native](https://reactnative.dev) is a framework developed by Facebook that enables you to build world-class application experiences on native platforms using a consistent developer experience based on JavaScript and [React](https://reactjs.org/). The focus of React Native is on developer efficiency across all the platforms you care about - learn once, write anywhere. |
| 22 | + |
| 23 | +- **Declarative.** React makes it painless to create interactive UIs. Declarative views make your code more predictable and easier to debug. |
| 24 | +- **Component-Based.** Build encapsulated components that manage their state, then compose them to make complex UIs. |
| 25 | +- **Developer Velocity.** See local changes in seconds. Changes to JavaScript code can be live reloaded without rebuilding the native app. |
| 26 | +- **Portability.** Reuse code across iOS, Android, and [other platforms][p]. |
| 27 | + |
| 28 | +React Native is developed and supported by many companies and individual core contributors. Find out more in our [ecosystem overview][e]. |
| 29 | + |
| 30 | +[r]: https://react.dev/ |
| 31 | +[p]: https://reactnative.dev/docs/out-of-tree-platforms |
| 32 | +[e]: https://github.com/facebook/react-native/blob/HEAD/ECOSYSTEM.md |
| 33 | + |
| 34 | +This repository is a working fork of **facebook/react-native** that adds support for the official React Native for macOS implementation from Microsoft. |
| 35 | + |
| 36 | +You can read more about the macOS implementation in our website - [React Native for Windows + macOS](https://microsoft.github.io/react-native-windows/). You can read about how we manage this fork in our [docs](docs/) folder. |
| 37 | + |
| 38 | +## Contents |
| 39 | + |
| 40 | +- [Requirements](#-requirements) |
| 41 | +- [Building your first React Native app](#-building-your-first-react-native-app) |
| 42 | +- [Documentation](#documentation) |
| 43 | +- [How to Contribute](#contributing) |
| 44 | +- [Code of Conduct](#code-of-conduct) |
| 45 | +- [License](#license) |
| 46 | + |
| 47 | + |
| 48 | +## 📋 Requirements |
| 49 | + |
| 50 | +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. |
| 51 | + |
| 52 | +## 🎉 Building your first React Native app |
| 53 | + |
| 54 | +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: |
| 55 | + |
| 56 | +- [Trying out React Native][hello-world] |
| 57 | +- [Creating a New Application][new-app] |
| 58 | +- [Adding React Native to an Existing Application][existing] |
| 59 | + |
| 60 | +[hello-world]: https://snack.expo.dev/@samples/hello-world |
| 61 | +[new-app]: https://reactnative.dev/docs/getting-started |
| 62 | +[existing]: https://reactnative.dev/docs/integration-with-existing-apps |
| 63 | + |
| 64 | +## Requirements |
| 65 | + |
| 66 | +You can run React Native for macOS apps on Mac devices with versions Catalina (10.15) or newer. |
| 67 | + |
| 68 | +For a full and detailed list of the system requirements and how to set up your development platform, see our [System Requirements](https://microsoft.github.io/react-native-windows/docs/rnm-dependencies) documentation on our website. |
| 69 | + |
| 70 | +## Getting Started |
| 71 | + |
| 72 | +See the [Getting Started Guide](https://microsoft.github.io/react-native-windows/docs/rnm-getting-started) on our React Native for Windows + macOS website to build your first React Native for macOS app. |
| 73 | + |
| 74 | +### Logging Issues |
| 75 | + |
| 76 | +Search the [existing issues](https://github.com/microsoft/react-native-macos/issues) and try to make sure your problem doesn’t already exist before opening a new issue. If your issue doesn't exist yet, try to make sure you provide as much information as possible to us so we can help you sooner. It’s helpful if you include information like: |
| 77 | + |
| 78 | +- The version of macOS, React Native, React Native macOS extension where you ran into the issue. |
| 79 | +- A stack trace and reduced repro case when possible. |
| 80 | +- Ensure the [appropriate template](https://github.com/microsoft/react-native-macos/issues/new/choose) is used when filing your issue(s). |
| 81 | + |
| 82 | +## Contributing |
| 83 | + |
| 84 | +See [Contributing guidelines](https://github.com/microsoft/react-native-macos/blob/master/CONTRIBUTING.md) for how to set up your fork of the repo and start a PR to contribute to React Native for macOS. |
| 85 | + |
| 86 | +[Good First Issue](https://github.com/microsoft/react-native-macos/labels/good%20first%20issue) and [help wanted](https://github.com/microsoft/react-native-macos/labels/help%20wanted) are great starting points for PRs. |
| 87 | + |
| 88 | +## Documentation |
| 89 | + |
| 90 | +The full documentation for React Native can be found on the [documentation 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]. |
| 91 | + |
| 92 | +The source for the React Native documentation and website is hosted on a separate repo, [**@facebook/react-native-website**][repo-website]. |
| 93 | + |
| 94 | +[React Native for Windows + macOS](https://microsoft.github.io/react-native-windows/) has its own separate documentation site where Windows and macOS |
| 95 | +specific information, like API docs and blog updates live. We are still working on the documentation for macOS, contributions are welcome! |
| 96 | + |
| 97 | +If you're looking for sample code, just browse the [RNTester folder](https://github.com/microsoft/react-native-macos/tree/master/packages/rn-tester) for examples |
| 98 | + |
| 99 | +### Git flow and syncing with upstream |
| 100 | + |
| 101 | +For more details on how this fork handles keeping up with upstream, and how the general git flow works, check out [this dedicated document](./docs/GitFlow.md). |
| 102 | + |
| 103 | +## License |
| 104 | + |
| 105 | +The React Native for macOS extension, including modifications to the original Facebook source code, and all newly contributed code is provided under the [MIT License](LICENSE). Portions of the React Native for macOS extension derived from React Native are copyright Facebook. |
| 106 | + |
| 107 | +## Code of Conduct |
| 108 | + |
| 109 | +This project has adopted the [Microsoft Open Source Code of Conduct ](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments. |
| 110 | + |
| 111 | +[docs]: https://reactnative.dev/docs/getting-started |
| 112 | +[r-docs]: https://react.dev/learn |
| 113 | +[repo-website]: https://github.com/facebook/react-native-website |
| 114 | + |
| 115 | +## 🚀 Upgrading |
| 116 | + |
| 117 | +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. |
| 118 | + |
| 119 | +React Native releases are discussed [in this discussion repo](https://github.com/reactwg/react-native-releases/discussions). |
| 120 | + |
| 121 | +[u]: https://reactnative.dev/docs/upgrading |
| 122 | +[repo-releases]: https://github.com/react-native-community/react-native-releases |
| 123 | + |
| 124 | +## 👏 How to Contribute |
| 125 | + |
| 126 | +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. |
| 127 | + |
| 128 | +### [Code of Conduct][code] |
| 129 | + |
| 130 | +Facebook has adopted a Code of Conduct that we expect project participants to adhere to. |
| 131 | +Please read the [full text][code] so that you can understand what actions will and will not be tolerated. |
| 132 | + |
| 133 | +[code]: https://code.fb.com/codeofconduct/ |
| 134 | + |
| 135 | +### [Contributing Guide][contribute] |
| 136 | + |
| 137 | +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. |
| 138 | + |
| 139 | +[contribute]: https://reactnative.dev/docs/contributing |
| 140 | + |
| 141 | +### [Open Source Roadmap][roadmap] |
| 142 | + |
| 143 | +You can learn more about our vision for React Native in the [**Roadmap**][roadmap]. |
| 144 | + |
| 145 | +[roadmap]: https://github.com/facebook/react-native/wiki/Roadmap |
| 146 | + |
| 147 | +### Good First Issues |
| 148 | + |
| 149 | +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. |
| 150 | + |
| 151 | +[gfi]: https://github.com/facebook/react-native/labels/good%20first%20issue |
| 152 | + |
| 153 | +### Discussions |
| 154 | + |
| 155 | +Larger discussions and proposals are discussed in [**@react-native-community/discussions-and-proposals**][repo-meta]. |
| 156 | + |
| 157 | +[repo-meta]: https://github.com/react-native-community/discussions-and-proposals |
| 158 | + |
| 159 | +## 📄 License |
| 160 | + |
| 161 | +React Native is MIT licensed, as found in the [LICENSE][l] file. |
| 162 | + |
| 163 | +React Native documentation is Creative Commons licensed, as found in the [LICENSE-docs][ld] file. |
| 164 | + |
| 165 | +[l]: https://github.com/facebook/react-native/blob/main/LICENSE |
| 166 | +[ld]: https://github.com/facebook/react-native/blob/main/LICENSE-docs |
0 commit comments