If you find any errors, typos or have general feedback, select the text and click CTRL+ALT+ENTER.

Overview

Appery.io makes it easy to export (download) or package your app as:

  • Android and iOS
  • Android and iOS project source files
  • Mobile web app (HTML/JavaScript/CSS)
  • Appery.io plug-in
  • Perform automatic app update without going through an app store.

To view the export options, click the “Export” button in the top menu:

Export options

Automatic update

Automatic update allows you to update your app without going through an app store. Please read here for more information on how to use automatic update.

Android

You have several options when exporting your app for Android:

  • Binary app (.apk) – this Android binary version can be published to the Google Play.
  • Android Studio project (source code) – you get HTML/CSS/JS + the Cordova library configured as an Android Studio project.

For JQM apps with older lib versions (lower than 3.0) building as an Eclipse project is available. See here for exporting as Eclipse project.

Binary app

Appery.io platform provides a cloud build service that will package the app as a Cordova app for Android which you can publish to Google Play. To start the build process, simply click Export > .apk. The build usually takes one minute. Once the build is completed, the binary file will be downloaded to your computer. You can also scan the QR code shown to start the download of the binary file on your Android device.

Before you can publish apps to the Google Play Market, you need to pay a $25 registration fee.

Settings

Appery.io comes with an editor that allows you to enter and edit all necessary Android .apk properties in order to prepare it for the Google Play Market. To open the editor, go to Project view > Project > App settings > Android binary. To switch to Release mode, check the “Release” box. If the “Release” box is checked, JavaScript assets will be minified to reduce the binary size.

Android binary settings

 

Keep the keystore file containing your private key and certificate information in a safe, secure place. If you delete your Appery.io app, this information will be impossible to restore, even from the project backup. That’s why we urge you to generate certificates and store them locally; if you decide to delete your Appery.io project for some reason, you’ll still have them.

For more information about certificates, read http://developer.android.com/tools/publishing/app-signing.html.

Building with Android Studio or Eclipse

You have the option to build the binary file with Android Studio or Eclipse

Android Studio

After building an Android Studio project, you can browse the app resources, source files and see the overall project structure.

JQM projects with older lib versions (earlier than 3.0) offer building as a binary .apk or exporting as Eclipse projects.

Setting up an Eclipse project

Here are the steps on how to properly configure project for Eclipse:

  1. Extract archive into the DIR folder.
  2. Create empty BarcodeScanner directory at DIR folder.
  3. Go to DIR/<project_name>/repo/com/phonegap/plugins/BarcodeScanner/1.0.
  4. Find BarcodeScanner-1.0.apklib file. It’s a ZIP-file with apklib extension. Unpack this file into DIR > BarcodeScanner directory.
  5. Open Eclipse.
  6. Import BarcodeScanner:
    1. Select File > Import menu.
    2. Select Android > Existing Android Code into Workspace.
    3. Click “Next”.
    4. Select DIR > BarcodeScanner as root directory.
    5. Click “Finish”.
    6. CapruteActivity project appears at your Eclipse workspace.
    7. Click right mouse button and select Properties menu item.
    8. Go to Android section.
    9. Check 4.1.2 Android platform.
    10. Check Is Library checkbox at the bottom.
    11. Click “OK”.
    12. Clean CaptureActivity by clicking Project - Clean (Clean all).
    13. CaptureActivity shouldn’t have any error at the moment.
  7. Import your App:
    1. Click File > Import.
    2. Click General > Existing Project into Workspace.
    3. Select your app directory as DIR > <project_name>.
    4. Import you project.
    5. Clean projects by clicking Project - Clean (Clean all).
    6. All projects should be valid and contain no errors.

Done. You can run your app from Eclipse.

Known issues

Troubleshooting Android build

The following is a list of the most common reasons the Android build might fail. Please correct them and try to export again:

1. The custom certificate is uploaded, but the app is trying to build with auto-generated certificate:

If you have uploaded a custom certificate, make sure the auto-generated certificate isn’t selected.

2. Changes made in the Source view:

If you’ve made any changes in the Source view, this might be causing the build to fail. Delete the edited files, then select the “gear” icon, and “Undo all source changes” for the Android folder.

3. App icons:

Double check that all the app icons you uploaded are in the correct format and have the correct names.

Known build bugs

There are two known bugs that may cause the build to fail:

1. Changing the package name:

If you changed the app package name and the build now fails, switch to Source view. For the Android folder, select the “gear” icon, then “Undo all source changes.” Try to export again.

2. Missing certificate:

Click “Change” for the Keystore file and select the certificate. Try to export again.

iOS

You have several options when exporting your app for iOS:

  • Binary app (.ipa) – this iOS binary version can be published to the App Store etc.
  • xCode project (source code) – you get HTML/CSS/JS + the PhoneGap library configured as an xCode project.

Binary app

Appery.io platform provides a cloud build service that will package the app as a Cordova app for iOS which you can publish to the App Store. Before you build the binary file, make sure you have the following:

  • Apple certificate (***.p12).
  • Apple provision profile (***.provision).
  • Bundle ID (com.company.***) – you can find it in your Apple certificate.

Before you can build an iOS binary, you need to sign up for the iOS Developer Program and provide all developer information and certificates below. If you are new to this, this is a good link to get you started: managing your signing and provisioning assets.

You also will need a Mac to submit the binary to App Store. Or see alternative variants here (forum).

Settings

Appery.io comes with iOS binary file settings where you can configure everything you need to package the app for iOS.

iOS settings editor

If the “Release” box is checked, JavaScript assets will be minified to reduce the binary size:

Generating iOS certificates

The following links will help you generate the iOS certificate and submit the app to the Apple App Store.

Submitting the app to the Apple App Store is outside the scope of our support.

Windows
Mac OS

For the latest information, please visit: https://developer.apple.com/.

Certificate management

Certificate management can be accessed under the Resources tab. This is where all of your certificates are stored:

iOS certificate managment

Certificates can be imported or automatically generated (in the case of Android). Click “Import certificate” to upload the certificate from your desktop.

Once the file and platform are chosen, type the certificate name and its password. Click “Import certificate” to upload the file.

We strongly recommend that you store all of your certificates locally and don’t remove them for any reason.

The imported certificate will be listed with all the others.

The certificate can be set to use by default. That means that all applications will use this certificate if another isn’t specified in App settings. Check “Default” to make the certificate used by default.

If you are a team member, the team admin or team lead should give you permission for this action:
To view the certificate data or change its displayed name, select it from the list. A pop-up window with information about the certificate will appear:

Type a new name for the certificate, and click “Apply” to change the certificate name. By clicking “Export,” the certificate will be downloaded to your desktop.

By clicking “Export to zip,” the certificate will be downloaded as a ZIP archive. The archive will also contain additional text files with certificate passwords. Click “Delete” to remove the certificate.

If you delete a certificate that’s used in any application, you’ll get an error.

Once the certificates are uploaded, they can be chosen from the application settings. To choose a certificate for iOS binary, go to App settings > iOS binary and choose a certificate:

When [use default] is selected, the certificate marked as default in the Certificates tab will be used. In the same way, certificates can be set for all binaries.

After registering with Apple as a developer you can get provisioning profile files or generate them. In the builder, click “Change” to open the Files Manager:

At least one certificate must be provided to build a certain binary. In other cases, when exporting this binary in the builder you will get an error.

Building iOS app with xCode

Before you begin, you need:

  • Mac OS X 10.9+
  • Xcode 6+ with iOS SDK installed.
  • You should be enrolled in the iOS development program and have the correct pair of developer (or distribution) certificate and provisioning profiles. You can get Xcode, iOS SDK, certificates, and profiles from http://developer.apple.com. Please refer to the corresponding documentation from Apple.

Running in iOS Simulator

If you want to run an Appery.io app in the iOS Simulator:

  1. Open [app_name].xcodeproj with Xcode.
  2. Select the correct scheme to run: [app_name] > iPhone X or [app_name] > iPad X in the top-left part of the Xcode window.
  3. Click “Run” in the top-left corner of the Xcode window (PushApp is the app name):

You should see the “Build successful” message, then – the iOS Simulator running, and the Appery.io app launched.

Running on iOS device (iPhone, iPad)

Running the Appery.io app on a iOS device is a more involved procedure than running it on the simulator. Notice that steps #1 and #2 are optional if you’ve already completed them for a different app.

1. Add the certificate to the keychain. Double-click on the .cer file and confirm adding the certificate. You can see the certificate in the keychain window.

Repeat for the distribution certificate:

2. Open the [app_name].xcodeproj with Xcode.
3. Select the [app_name] project file at the top of the project navigator.
4. Select the Build Settings tab, and proceed to the Code Signing section (PushApp is the app name).
5. Find the Code Signing Identity group and open it. If you use the app source code you built and exported from Appery.io, there should be 2 sub items – Debug and Release:
2 Code Signing

6. Different certificates can be used for different purposes:

  • If you have a developer’s certificate, you should ensure that the values for Debug > Any iOS SDK and Release > Any iOS SDK are set to your developer’s certificate. We recommend setting the iOS Developer value there, which enables automatic profile selection. However, you can click the value, and see the certificate and profile that can be used by Xcode for code signing:

7. Open the General tab of the [app_name].xcodeproj. Find the Bundle identifier parameter, and set its value to the corresponding value of the allowed application identifiers for your provisioning profile:

8. Select the correct scheme to run: [app_name] > [Your connected device's name].

9. Click “Run” in the top-left corner of the Xcode window:

Known issues

Troubleshooting iOS build

The following is a list of the most common reasons the iOS build might fail. Please check them and try to export again:

  1. Bundle ID doesn’t match the Provisioning profile – Please check to make sure your Bundle ID matches the Provisioning profile.
  2. Bundle ID incorrect format – The Bundle ID provided has an incorrect format. The Bundle ID format is: com.companyName.appName. This is NOT a valid Bundle ID: XZCSDF.com.companyName.appName.

    Please read http://stackoverflow.com/questions/3436260/bundle-id-suffix-what-is-it for more information.

  3. Expired certificate – Please make sure your certificate hasn’t expired.
  4. No certificate uploaded – Please make sure you have uploaded a valid certificate.

Troubleshooting iOS submission

iPhone and iPad permissions

Check the app permissions. For instance, if you have telephony selected in UIRequiredDeviceCapabilities (Project > App settings > iOs keys), and you are submitting the app for iPad as well, the App Store will not accept the app as you cannot make calls from an iPad.

Your app will still install and work fine when you test, but the App Store will not accept it.

Mobile web

To download the app as a mobile web app, select “HTML/JS/CSS.”

Exporting as Appery.io plug-in

Exporting your Appery.io project as a plug in is described in the creating a plug-in section.

Certificate management

Certificate management can be accessed under the Resources > Certificates tab. This is where all of your certificates are stored:

Certificates can be imported or automatically generated (in the case of Android). Click “Import certificate” to upload the certificate from your desktop:
ImportCert

Once the file and platform are chosen, type the certificate name and its password. Click “Import certificate” to upload the file.

You should upload your .p12 file. In other cases you’ll get the following error:

NoRegistration1

Make sure, you enter the correct password, otherwise you will get the “Password verification failed” message.

We strongly recommend that you store all of your certificates locally and don’t remove them for any reason.

Android certificates can be automatically generated. To do so, click “Generate certificate”:
GenerateAndroidCert

Type the certificate name and password, and then click “Generate.” The generated certificate will be listed with all the others:
List

The certificate can be set to use by default. That means that all applications will use this certificate if another isn’t specified in App settings. Check “Default” to make the certificate used by default.

If you are a team member, the team admin or team lead should give you permission for this action:

MakeDefault

You will get the “Certificate became default” message.

To view the certificate data or change its displayed name, select it from the list. A pop-up window with information about the certificate will appear:

Type a new name for the certificate, and click “Apply” to change the certificate name. By clicking “Export,” the certificate will be downloaded to your desktop.

By clicking “Export to zip,” the certificate will be downloaded as a ZIP archive. The archive will also contain additional text files with certificate passwords. Click “Delete” to remove the certificate.

If you delete a certificate that’s used in any application, you’ll get an error.

Once the certificates are uploaded, they can be chosen from the application settings. To choose a certificate for Android binary, go to App settings > Android binary and choose a certificate:
AndroidBinaryDefault

When [use default] is selected, the certificate marked as default in the Certificates tab will be used. In the same way, certificates can be set for all binaries.

By clicking “Manage certificates” you can switch to the Resources tab with all your certificates:
ManageCert

Switch to the iOS binary tab in App settings to select a certificate:

After registering with Apple as a developer you can get provisioning profile files or generate them. In the builder, click “Change” to open the Files Manager:

Here, you can upload you files:

At least one certificate must be provided to build a certain binary. In other cases, when exporting this binary in the builder you will get an error:BuildError