81 строка
5.2 KiB
Markdown
81 строка
5.2 KiB
Markdown
<h1 align="center"> React Native for macOS </h1>
|
||
|
||
<p align="center">
|
||
Build native macOS apps with React.
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/microsoft/react-native-macos/blob/master/LICENSE">
|
||
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="React Native for macOS is released under the MIT license." />
|
||
</a>
|
||
<a href="https://www.npmjs.org/package/react-native-macos">
|
||
<img src="https://img.shields.io/npm/v/react-native-macos?color=e80441&label=react-native-macos" alt="Current npm package version." />
|
||
</a>
|
||
<a href="https://github.com/microsoft/react-native-macos/blob/master/CONTRIBUTING.md">
|
||
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome!" />
|
||
</a>
|
||
</p>
|
||
|
||
> See the official [React Native website](https://reactnative.dev/) for an introduction to React Native.
|
||
|
||
[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.
|
||
|
||
This repository is a working fork of **facebook/react-native** that adds support for the official React Native for macOS implementation from Microsoft.
|
||
|
||
[hello-world]: https://snack.expo.io/@hramos/hello,-world!
|
||
[new-app]: https://reactnative.dev/docs/getting-started
|
||
[existing]: https://reactnative.dev/docs/integration-with-existing-apps
|
||
|
||
You can read more about the macOS implementation in our website - [React Native for Windows + macOS](https://microsoft.github.io/react-native-windows/)
|
||
|
||
## Requirements
|
||
|
||
You can run React Native for macOS apps on Mac devices with versions Catalina (10.15) or newer.
|
||
|
||
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.
|
||
|
||
## Getting Started
|
||
|
||
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.
|
||
|
||
### Logging Issues
|
||
|
||
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:
|
||
|
||
- The version of macOS, React Native, React Native macOS extension where you ran into the issue.
|
||
- A stack trace and reduced repro case when possible.
|
||
- Ensure the [appropriate template](https://github.com/microsoft/react-native-macos/issues/new/choose) is used when filing your issue(s).
|
||
|
||
## Contributing
|
||
|
||
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.
|
||
|
||
[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.
|
||
|
||
## Documentation
|
||
|
||
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].
|
||
|
||
The source for the React Native documentation and website is hosted on a separate repo, [**@facebook/react-native-website**][repo-website].
|
||
|
||
[React Native for Windows + macOS](https://microsoft.github.io/react-native-windows/) has its own separate documentation site where Windows and macOS
|
||
specific information, like API docs and blog updates live. We are still working on the documentation for macOS, contributions are welcome!
|
||
|
||
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
|
||
|
||
### Git flow and syncing with upstream
|
||
|
||
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).
|
||
|
||
## License
|
||
|
||
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.
|
||
|
||
## Code of Conduct
|
||
|
||
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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||
|
||
[docs]: https://reactnative.dev/docs/getting-started
|
||
[r-docs]: https://reactjs.org/docs/getting-started.html
|
||
[repo-website]: https://github.com/facebook/react-native-website
|