DocumentationAEM 6.4Mobile Guide

Developing Apps with PhoneGap CLI developing-apps-with-phonegap-cli

Last update: Wed May 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User
CAUTION
AEM 6.4 has reached the end of extended support and this documentation is no longer updated. For further details, see our technical support periods. Find the supported versions here.
NOTE
Adobe recommends using the SPA Editor for projects that require single page application framework-based client-side rendering (e.g. React). Learn more.

At any given time, as a developer you can run your app on a device or within a emulator, provided you’ve configured your development environment.

In order to run the following examples you will need a system that runs OSx (Mac) with Xcode, or a Mac/Win/Linux system with the Android SDK installed.

Bootstrap your development environment bootstrap-your-development-environment

Setup PhoneGap CLI

For iOS: To develop for iPhones and iPads, you need Apple’s Xcode IDE.

For Android: To develop for iPhones and iPads, you need Google’s Android Stuido IDE.

Download the Source download-the-source

Once you’ve successfully boostrapped your development environment, download the source from the AEM App Build Tile:

  • Click on the PhoneGap Build tile dropdown chevron.

chlimage_1-45

  • Click Download Source.
  • Select the desired source from the Download Source modal.

chlimage_1-46

NOTE
The development source contains the latest state of your app, while including un-staged changes. Use the Staging source for building release candidates for submitting to app store vendors.
If you never stage your app, selecting Staging will trigger the staging workflow (hint: this will show up as a staged app in the PhoneGap Enterprise Viewer App available in the AppStore and Google PlayStore).
  • Click Download and save save the ZIP to your machine.
  • Extract the downloaded zip file to your workspace.

Build and load the App (from source) build-and-load-the-app-from-source

PhoneGap CLI can create a platform project, compile the source, and deploy the app in a single command.

NOTE
You can do all these steps separately, see PhoneGap CLI docs.
  1. Make sure you’ve Installed PhoneGap CLI, see above.
  2. In a console (or terminal) window, navigate to the root directory of your extracted source.
  3. Enter the following command:
phonegap run android

// -- or -- //

phonegap run ios
NOTE
If you have issues at this point, go back to basics to trouble-shoot -
  1. Create a new folder (mkdir test)
  2. Navigate into this new folder (cd test)
  3. Run ‘phonegap create helloWorld’
  4. Navigate into helloWorld (cd helloWorld)
  5. Run 'phonegap run android (or replace android with ios as above).
  6. Emulator wil open running your newly created PhoneGap App, saying ‘Device Ready’ if the JavaScript bridge to native is operational.
This will verify that you’re PhoneGap CLI development environment is up and running correctly.

Debug Javascripts with Safari and IOS debug debug-javascripts-with-safari-and-ios-debug

You can debug your app’s JavaScripts using Safari’s developer tools, the same way you would with a web application.

Enable Safari Developer Tools enable-safari-developer-tools

To enable the developer tools:

  • Open Safari’s preferences

    • Click Safari in menu bar
    • Click Preferences

  • Click Advanced in Preference window

chlimage_1-47

  • Check “Show Develop menu in menu bar”
  • Close the Preference window

Connect Safari to iOS connect-safari-to-ios

You can connect Safari to either an iOS device or emulator.

  • In a console window, navigate to the root directory of your extracted source.
  • Enter the following command to launch your app on your device or emulator.
phonegap run <platform> --device

// -- or -- //

phonegap run <platform> --emulator
  • Open Safari
  • Click Develop in the menu bar
  • Select iOS Simulator sub menu
  • Click on home.html

chlimage_1-48

Debug JavaScript with Safari’s Web Inspector debug-javascript-with-safari-s-web-inspector

You can set breakpoints anywhere in your source. When you interact with your emulator or device, the execution of your app will stop at those breakpoints. You can step trough the execution and inspect the values in variables.

  • Click Resources in the Web Inspector window
  • Navigate the source tree and click on desired source file
  • Click on the line number adjacent to add a breakpoint
  • Interact with device or emulator

chlimage_1-49

  • Use the control buttons to continue execution, step over, step into and step out of methods:

NOTE
To see the values of variables, in the current method, hover your mouse.

The Next Steps the-next-steps

Once you have learnt about Developing Apps with PhoneGap CLI, see Accessing Device Features.

recommendation-more-help
547b817b-14b5-4d82-aa0f-a64750e0e592