Skip to main content

Get Started

This guide will help you get started on setting up your very first React Native for macOS app.

** Please check either NPM or our GitHub releases to see our latest release**

For information around how to set up:

Install React Native for macOS

Remember to call @react-native-community/cli init from the place you want your project directory to live. Be sure to use the same minor version between React Native and React Native macOS. We'll use ^0.78.0

npx @react-native-community/cli init <projectName> --version 0.78

Once your project has been initialized, React Native will have created a new sub directory where all your generated files live.

cd <projectName>

Install the macOS extension

Install the React Native for macOS packages.

npx react-native-macos-init

Running a React Native macOS App

  • Without using Xcode: In your React Native macOS project directory, run:

    npx react-native run-macos
  • Using Xcode: Open macos\test.xcworkspace in Xcode or run xed -b macos; yarn start. Hit the Run button.

A new Command Prompt window will open with the React packager as well as a react-native-macos app. This step may take a while during first run since it involves building the entire project and all dependencies. You can now start developing! 🎉