Run Hybrid Apps in the Cordova Developer App

Filter by IDE
Select the AppBuilder client you are currently using for development.

IDE

The Cordova developer app is a test utility for iOS, Android and Windows Phone devices and is available as a free app in the App Store, Google Play and the Windows Phone Store. The Cordova developer app acts as a container app. When you deploy your app on the device, the AppBuilder Compiler Service pushes it down to device and runs it inside the Cordova developer app container. The Cordova developer app does not interfere with your app look and feel.

The Cordova developer app is available for iOS, Android, and Windows Phone.

  • When you develop for iOS, you can run your app on iOS devices without building and signing it with a provisioning profile and cryptographic identity.
  • When you develop for Android, you can run your app on Android devices without building an application package and installing it on the device.
  • When you develop for Windows Phone, you can run your app on Windows Phone devices without building an application package and installing it on the device.

For iOS and Android, you need to use the Cordova developer app with the Platform companion app.

For Windows Phone, you can use the Cordova developer app as a standalone app.

Prerequisites

  • Verify that your preferred AppBuilder client is running and you are logged in.
  • Verify that you have opened the code for your app in AppBuilder.
  • Verify that you have installed the latest version of the Platform companion app on your device.
  • Verify that you have installed the latest version of the Cordova developer app on your device.
  • Verify that your app targets the latest supported version of Apache Cordova.
  • (Optional) If you want to manage your hybrid app developed with extension for Visual Studio from the Platform companion app, verify that you have connected your code with the cloud.

Procedure

In-Browser

Run from the Platform Companion App

You can load your app inside the Cordova developer app from the Platform companion app. This way you can view your app logs and test the available build configurations for your app.

IMPORTANT: You can perform this operation only on iOS and Android devices.

  1. Run the Platform companion app.
  2. On the home screen, tap My Apps.
  3. If prompted to log in, select a login provider and enter your login credentials.
  4. (Optional) Verify that you are using the correct Telerik Platform account.
    1. On the Apps screen, tap the user icon in the top right corner.
    2. Select the account that you want to use and wait for the operation to complete.
    3. Tap Done.
  5. (Optional) Configure the app that you want to run.
    1. On the Apps screen, tap the app that you want to run.
    2. Tap Configuration.
    3. Select the configuration that you want to apply to this app.
      Option Description
      Debug
      • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
      • Includes any *.debug.* files in your application package, removes the debug modifiers from the file names and renames them to *.*.
      Release
      • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
      • Includes any *.release.* files in your application package, removes the release modifiers from the file names and renames them to *.*.
    4. Return to the Apps screen.
  6. Tap Open.
    If you see Install instead of Open, you have not installed the Cordova developer app on your device. Install the missing developer app and try again.

Run Over the Air

You can deploy your app in the Cordova developer app from QR code or URL.

For iOS and Android, the Platform companion app recognizes and loads Apache Cordova apps from URLs which begin with icenium://https

For Windows Phone, the Cordova developer app recognizes and loads Apache Cordova apps from URLs which begin with icenium://https

AppBuilder produces the QR codes and the download URLs to your built content per build. Your shared QR codes or URLs provide access to a particular build and have a limited life.

  1. In the top menu bar, click RunBuild.
  2. Select your target mobile platform and select Cordova developer app.
  3. Select a build configuration, and click Next.
    Option Description
    Debug
    • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
    • Includes any *.debug.* files in your application package, removes the debug modifiers from the file names and renames them to *.*.
    Release
    • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
    • Includes any *.release.* files in your application package, removes the release modifiers from the file names and renames them to *.*.
  4. For iOS and Android devices, complete the following steps to deploy from QR code.
    1. On the device, run the Platform companion app.
    2. Tap QR Scanner.
    3. Scan the QR code that AppBuilder shows.
  5. For Windows Phone devices, complete the following steps to deploy from QR code.
    1. On the device, run the Cordova developer app.
    2. With two fingers, tap and swipe the left edge of the screen to the right to toggle the sidebar menu.
    3. Tap QR Scanner.
    4. Scan the QR code that AppBuilder shows.
  6. Complete the following steps to deploy from URL.
    1. Select the URL above the QR code that AppBuilder shows.
    2. Copy the URL and share it to your device.
    3. On the device, use a browser to open the URL.
  7. Wait for the download to complete.
    On the device, the app loads in the Cordova developer app.
  8. (Optional) Share the QR code or the URL with your testers.

Windows

Run from the Platform Companion App

You can load your app inside the Cordova developer app from the Platform companion app. This way you can view your app logs and test the available build configurations for your app.

IMPORTANT: You can perform this operation only on iOS and Android devices.

  1. Run the Platform companion app.
  2. On the home screen, tap My Apps.
  3. If prompted to log in, select a login provider and enter your login credentials.
  4. (Optional) Verify that you are using the correct Telerik Platform account.
    1. On the Apps screen, tap the user icon in the top right corner.
    2. Select the account that you want to use and wait for the operation to complete.
    3. Tap Done.
  5. (Optional) Configure the app that you want to run.
    1. On the Apps screen, tap the app that you want to run.
    2. Tap Configuration.
    3. Select the configuration that you want to apply to this app.
      Option Description
      Debug
      • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
      • Includes any *.debug.* files in your application package, removes the debug modifiers from the file names and renames them to *.*.
      Release
      • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
      • Includes any *.release.* files in your application package, removes the release modifiers from the file names and renames them to *.*.
    4. Return to the Apps screen.
  6. Tap Open.
    If you see Install instead of Open, you have not installed the Cordova developer app on your device. Install the missing developer app and try again.

Run Over the Air

You can deploy your app in the Cordova developer app from QR code or URL.

The Cordova developer app recognizes and loads Apache Cordova apps from URLs which begin with icenium://https

AppBuilder produces the QR codes and the download URLs to your built content per build. Your shared QR codes or URLs provide access to a particular build and have a limited life.

  1. In the top menu bar, click RunBuild.
  2. Select your target mobile platform, select AppBuilder companion app, select a build configuration, and click Next.
  3. For iOS and Android devices, complete the following steps to deploy from QR code.
    1. On the device, run the Platform companion app.
    2. Tap QR Scanner.
    3. Scan the QR code that AppBuilder shows.
  4. For Windows Phone devices, complete the following steps to deploy from QR code.
    1. On the device, run the Cordova developer app.
    2. With two fingers, tap and swipe the left edge of the screen to the right to toggle the sidebar menu.
    3. Tap QR Scanner.
    4. Scan the QR code that AppBuilder shows.
  5. Deploy from URL.
    1. Click Copy link and share the URL to your device.
    2. On the device, use a browser to open the URL.
  6. Wait for the download to complete.
    On the device, the app loads in the Cordova developer app.
  7. (Optional) Share the QR code or the URL with your testers.

Run Over Cable

You can deploy your app in the Cordova developer app by connecting your device to your system and running AppBuilder.

On Windows Phone devices, you cannot load your app in the companion app via cable connection.

  1. Connect your device to your system via USB cable.
  2. In the status bar, click Show Mobile Devices and verify that AppBuilder lists your connected device.
  3. In the Devices pane, verify that Companion app LiveSync is enabled.
  4. In the status bar, click Show Output and verify that AppBuilder has deployed your app files on the connected device.
  5. On the device, launch the Cordova developer app.

Visual Studio

Run from the Platform Companion App

You can load your app inside the Cordova developer app from the Platform companion app. This way you can view your app logs and test the available build configurations for your app.

IMPORTANT: You can perform this operation only on iOS and Android devices.

  1. Run the Platform companion app.
  2. On the home screen, tap My Apps.
  3. If prompted to log in, select a login provider and enter your login credentials.
  4. (Optional) Verify that you are using the correct Telerik Platform account.
    1. On the Apps screen, tap the user icon in the top right corner.
    2. Select the account that you want to use and wait for the operation to complete.
    3. Tap Done.
  5. (Optional) Configure the app that you want to run.
    1. On the Apps screen, tap the app that you want to run.
    2. Tap Configuration.
    3. Select the configuration that you want to apply to this app.
      Option Description
      Debug
      • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
      • Includes any *.debug.* files in your application package, removes the debug modifiers from the file names and renames them to *.*.
      Release
      • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
      • Includes any *.release.* files in your application package, removes the release modifiers from the file names and renames them to *.*.
    4. Return to the Apps screen.
  6. Tap Open.
    If you see Install instead of Open, you have not installed the Cordova developer app on your device. Install the missing developer app and try again.

Run Over the Air

You can deploy your app in the Cordova developer app from QR code or URL.

The Cordova developer app recognizes and loads Apache Cordova apps from URLs which begin with icenium://https

AppBuilder produces the QR codes and the download URLs to your built content per build. Your shared QR codes or URLs provide access to a particular build and have a limited life.

  1. In the top menu bar, click AppBuilderBuild <app_name> in Cloud.
  2. Select your target mobile platform, select AppBuilder companion app, select a build configuration, and click Next.
  3. Select a build configuration, and click Next.
    Option Description
    Debug
    • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
    • Includes any *.debug.* files in your application package, removes the debug modifiers from the file names and renames them to *.*.
    Release
    • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
    • Includes any *.release.* files in your application package, removes the release modifiers from the file names and renames them to *.*.
  4. For iOS and Android devices, complete the following steps to deploy from QR code.
    1. On the device, run the Platform companion app.
    2. Tap QR Scanner.
    3. Scan the QR code that AppBuilder shows.
  5. For Windows Phone devices, complete the following steps to deploy from QR code.
    1. On the device, run the Cordova developer app.
    2. With two fingers, tap and swipe the left edge of the screen to the right to toggle the sidebar menu.
    3. Tap QR Scanner.
    4. Scan the QR code that AppBuilder shows.
  6. Deploy from URL.
    1. Click Copy and share the URL to your device.
    2. On the device, use a browser to open the URL.
  7. Wait for the download to complete.
    On the device, the app loads in the Cordova developer app.
  8. (Optional) Share the QR code or the URL with your testers.

Run Over Cable

You can deploy your app in the Cordova developer app by connecting your device to your system and running AppBuilder.

On Windows Phone devices, you cannot load your app in the companion app via cable connection.

  1. Connect your device to your system via USB cable.
  2. (Optional) In the top tool bar, select your build configuration from the configuration drop-down.
    Option Description
    Debug
    • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
    • Includes any *.debug.* files in your application package, removes the debug modifiers from the file names and renames them to *.*.
    Release
    • Adds the plugins that you have enabled for this configuration and sets their plugin variables with the correct values.
    • Includes any *.release.* files in your application package, removes the release modifiers from the file names and renames them to *.*.
  3. In the Standard toolbar, select AppBuilderDevices List and verify that AppBuilder lists your connected device.
  4. Verify that Companion app LiveSync is enabled.
  5. In the top menu bar, click ViewOutput to show the output for your app.
  6. In the Output window, from the Show output from drop-down menu, select AppBuilder and verify that AppBuilder has deployed your app files on the connected device.
  7. On the device, launch the Cordova developer app.

CLI

Run Over the Air

You can deploy your app in the Cordova developer app from a QR code.

AppBuilder produces the QR codes and the download URLs to your built content per build. Your shared QR codes or URLs provide access to a particular build and have a limited life.

  1. In the command prompt, navigate to the directory that contains your app.
  2. Run the following command.

    appbuilder build <Platform> --companion <configuration>
    

    You can set one of the following platforms: ios, android, or wp8. You can set one of the following configurations: --debug or --release.

  3. Wait for AppBuilder to launch your default browser and show the QR code for deploying your app.
  4. For iOS and Android devices, complete the following steps to deploy from QR code.
    1. On the device, run the Platform companion app.
    2. Tap QR Scanner.
    3. Scan the QR code that AppBuilder shows.
  5. For Windows Phone devices, complete the following steps to deploy from QR code.
    1. On the device, run the Cordova developer app.
    2. With two fingers, tap and swipe the left edge of the screen to the right to toggle the sidebar menu.
    3. Tap QR Scanner.
    4. Scan the QR code that AppBuilder shows.
  6. Wait for the download to complete.
  7. (Optional) Share the QR code with your testers.

Run Over Cable

You can deploy your app in the Cordova developer app by connecting your device to your system and running AppBuilder.

On Windows Phone devices, you cannot load your app in the developer app via cable connection.

  1. In the command prompt, navigate to the directory that contains your app.
  2. Run the following command to load your app in the developer app.

    appbuilder livesync --companion
    

    The Cordova developer app automatically refreshes your app with the latest changes and the command-line interface releases the console.

  3. Run the following command to enable automatic LiveSync for saved changes.

    appbuilder livesync --companion --watch
    

    The Cordova developer app automatically refreshes your app with the latest changes. The command-line interface does not release the console and on every save pushes your changes to the developer app.

Next Steps

Continue development. After modifying your code, refresh or re-deploy your app.

(Optional) If you are running the extension for Visual Studio, you can remove app data from the cloud.

See Also

Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.