PhoneGap/Cordova
In PyCharm, you can develop applications intended for running on various mobile platforms, including Android, using the PhoneGap, Apache Cordova, and Ionic frameworks.
Before you start
Install and enable the PhoneGap/Cordova repository plugin on the Plugins page as described in Managing Plugins.
Install Node.js.
Download and install an emulator tool depending on the target platform and the operating system you use. Learn more from the Cordova Official website.
Installing PhoneGap/Cordova/Ionic
Open the built-in PyCharm Terminal (Alt+F12) and type one of the following commands at the command prompt:
npm install -- global phonegap npm install -- global cordova npm install -- global ionic
Creating a new PhoneGap/Cordova/Ionic application
If you have no application yet, you can generate a PyCharm project with PhoneGap/Cordova/Ionic-specific structure from a boilerplate template. Alternatively, create an empty PyCharm project and configure PhoneGap/Cordova/Ionic support in it as described in Starting with an existing Meteor application below.
To create a PhoneGap/Cordova/Ionic application from a template
Choose Create New Project on the Welcome screen. The New Project dialog box opens.
on the main menu or clickIn the left-hand pane, choose PhoneGap/Cordova App.
- In the right-hand pane:
Specify the path to the folder where the project-related files will be stored.
Specify the location of the executable file
phonegap.cmd
, orcordova.cmd
, orionic.cmd
(see Installing PhoneGap/Cordova/Ionic).
When you click Create, PyCharm generates a skeleton of a PhoneGap/Cordova/Ionic application with the framework-specific structure.
To create an empty PyCharm project
Choose Create New Project on the Welcome screen. The New Project dialog box opens.
on the main menu or clickIn the left-hand pane, choose Empty Project. In the right-hand pane, specify the application folder and click Create.
Starting with an existing PhoneGap/Cordova/Ionic application
Open the desired PhoneGap/Cordova/Ionic application in PyCharm by choosing on the main menu or clicking Open on the Welcome Screen.
In the Settings/Preferences dialog (Ctrl+Alt+S), click JavaScript under Languages and Frameworks, and then click Cordova. The Cordova page opens.
- Check the location of the executable file
phonegap.cmd
, orcordova.cmd
, orionic.cmd
or specify the path to it if PyCharm has not detected the executable file automatically.PyCharm detects the installed version and displays it in the PhoneGap/Cordova Version read-only field,
In the Cordova Working Directory field, specify the folder under which the PhoneGap/Cordova/Ionic application files to run are stored.
- In the Plugins area, configure a list of plugins to use in your development by installing required packages. The list shows all the PhoneGap/Cordova/Ionic plugins that are currently installed on your computer, both at the global and at the project level.
- To install a plugin, click the Install button . In the Available Packages dialog box that opens, select the required package.
To install the package globally, select the Options checkbox and type
--global
in the text box. Click Install Package. To remove a plugin, select it in the list and click the Uninstall button .
To upgrade a plugin to the latest available version, select the plugin in the list and click the Upgrade button .
- To install a plugin, click the Install button . In the Available Packages dialog box that opens, select the required package.
Creating and launching a PhoneGap/Cordova/Ionic run configuration
PhoneGap/Cordova/Ionic applications are executed according to a dedicated run/debug configuration.
On the main menu, choose Edit Configuration dialog box that opens, click the Add New Configuration toolbar button , and choose PhoneGap/Cordova on the context menu.
. In the- In the Run/Debug Configuration: PhoneGap/Cordova dialog box that opens, specify the following:
The name of the configuration.
In the PhoneGap/Cordova Executable Path field, specify the location of the executable file
phonegap.cmd
,cordova.cmd
, orionic.cml
(see Installing PhoneGap/Cordova/Ionic).In the PhoneGap/Cordova Working Directory field, specify the folder under which the PhoneGap/Cordova/Ionic application files to run are stored.
- From the Command drop-down list, choose the command to run. The contents of the drop-down list, depend on the actually used framework, namely, on the executable file specified in the PhoneGap/Cordova Executable Path field. The available options are:
- For PhoneGap:
emulate
run
prepare
serve
remote build
remote run
- For Cordova:
emulate
run
prepare
serve
- For Ionic:
emulate
run
prepare
serve
- For PhoneGap:
- From the Platform drop-down list, choose the platform for which the application is intended. The available options are:
- Android
ios To emulate this platform, you need to install the ios-sim command line tool globally. You can do it through the Node Package Manager (npm), see npm and Yarn or by running the
sudo npm install ios-sim -g
command, depending on your oeprating system.- amazon-fireos
- firefoxos
- blackberry10
- ubuntu
- wp8
- windows8
- browser
- For Cordova and Ionic, specify the targeted virtual or physical Android device to run the application on: select the Specify Target checkbox and select the required device from the drop-down list. The list shows all the virtual and physical devices that are currently configured on our machine. for details. Learn more about setting up emulators from the Cordova Official website.
If PyCharm displays the following error message: Cannot detect ios-sim in path, make sure you have installed the
ios-sim
, see Before you start.
To run a PhoneGap/Cordova/Ionic application, select the required run configuration from the list on the main tool bar and then choose on the main menu or click Run .