PyCharm integrates with React Native and helps you create, edit, lint, run, debug, and maintain your applications. PyCharm also provides code completion for React and Flow symbols.
Before you start
- Install Node.js.
- Install and activate the NodeJS repository plugin on the Plugins page as described in Installing, updating, and uninstalling repository plugins and Enabling and disabling plugins.
Installing react-native-cli globally
- Open the built-in Terminal ( ) and type
<nmp_path>\npm install -g react-native-cliat the command prompt.
Creating a new React Native application
To create an application
- Choose Create New Project on the Welcome screen. The New Project dialog box opens. on the main menu or click
- In the left-hand pane, choose React Native.
- In the right-hand pane, specify the project folder, the Node.js interpreter to use, and the path to the
- When you click Create, PyCharm generates a React Native-specific project with all the required configuration files.
To download the project dependencies, do one of the following:
- Open the embedded Terminal ( or Alt+F12) and type
<nmp_path>\npm installat the command prompt.
- Choose Run 'npm install' on the context menu of the
package.jsonfile in your project root.
Starting with an existing React Native application
To continue developing an existing React Native application, open it in PyCharm and download the required dependencies.
To open the application sources that are already on your machine
- Click Open on the Welcome screen or choose on the main menu. In the dialog that opens, select the folder where your sources are stored.
To check out the application sources from your version control
- Click Check out from Version Control on the Welcome screen or choose on the main menu.
- Select your version control system from the list.
- In the VCS-specific dialog that opens, type your credentials and the repository to check out the application sources from.
To download the dependencies
- Click Run 'npm install' in the pop-up window:
Install other tools to get started with React Native, for example, an iOS simulator. The list of these tools depends on your operating system and the mobile platform you are going to target your application at. See React Native Getting Started guide for detailed installation instructions.
Running and debugging a React Native application
You can run and debug your application on a physical device or on a simulator. Before you launch your application, make sure that the simulator is already running or, if you are using a physical device, it is already connected to your computer.
PyCharm makes running and debugging React Native applications very flexible. For example, if you are starting your application for the first time, you can choose to run the React Native bundler, build the application, and open it on the simulator - all that as part of a running or debugging session. You can also skip launching the bundler if it is already running or refuse building the application if you have not made any changes to its native code since the previous run.
To create a React Native run/debug configuration
- On the main menu, choose React Native from the list. , click and choose
- Choose whether you want PyCharm to build and launch the application for you:
- Select the Build and launch checkbox if you are launching your application for the first time or if you have updated its native code since the last run.
- Clear this checkbox if you haven't made any changes to the native code of your application since the last build. When you start debugging, PyCharm waits for you to open your application in the simulator with the Remote debug enabled as described on the React Native Official website.
- If your application uses Expo, clear the checkbox because this bundler takes care of the process itself.
- If you selected the Build and launch checkbox, choose the target platform, Android or iOS. Depending on your choice, PyCharm will run the bundler with
react-native run-iosor with
react-native run-android. Optionally, type the arguments to be passed to React Native, for example, specify the simulator type through the
- In the Bundler port, specify the port on which the React Native bundler runs, by default
8081is chosen, learn more from the React Native Official website.
- Choose the Node.js interpreter to use. This can be a see Configuring a local Node.js interpreter for details. Specify the path to
react-native-cliand the working directory of the application. Optionally, type the environment variables for
- By default, PyCharm starts the React Native bundler automatically when you invoke the run/debug configuration. If you have already started the bundler from outside PyCharm, for example, from the command line, you can re-use it without stopping and restarting. Select your bundler in the Before Launch area and click .
To prepare an Android device
To prepare an iOS simulator
- Open the embedded Terminal ( or Alt+F12) and type
<nmp_path>\npm install --global ios-simat the command prompt.
To run an application
- Choose the newly created React Native configuration in the Select run/debug configuration drop-down list on the toolbar and click next to it. PyCharm opens the Run tool window and first starts the React Native bundler in a new React Native tab. After that, the
react-native run-androidcommand is executed, depending on the selected target platform. If the build is successful, the simulator shows your application: