Skip to content

Latest commit

 

History

History
97 lines (50 loc) · 7.24 KB

RECIPE.md

File metadata and controls

97 lines (50 loc) · 7.24 KB
Raw

Zype Android Mobile Recipe

This document outlines step-by-step instructions for creating and publishing an Android mobile app powered by Zype's Endpoint API service and app production software and SDK template.

Requirements and Prerequisites

Technical Contact

IT or developer support strongly recommended. Completing app submission and publishing requires working with app bundles and IDE.

Mac with Android Studio installed

In order to compile, run, and package an app you need the latest version of Android Studio to be installed on your computer. Android Studio can be downloaded from the App Store.

Mac with ADB installed

You'll need to have ADB (Android Debug Bridge) installed in order to perform adb installs in terminal. To install them on your computer, follow the ADB documentation.

Creating a New App with the SDK Template

Generating the bundle and running the app

  1. In order to generate an Android bundle using this SDK, you must first pull the latest source code from Zype's github repository. This can be found at "https://github.com/zype/zype-android".

Select the green "Clone or download" button on the right.

From here, there are two options to copy the files:

a. Click the "Download ZIP" button on the bottom right. Then pick a folder to save the zipped files to.

Once the ZIP file is downloaded, open the file to reveal the contents.

OR

b. Click the "Git web URL" to highlight it and copy the URL.

Open terminal and "cd" into the folder you want to save the files to.

Helpful command line tips for Terminal
```
ls  ---> shows folders in current directory
cd Downloads  ---> goes into downloads if available (see ls)
cd Downloads/myproject  ---> goes into downloads/myproject if available (see ls)
cd ..  ---> goes back one directory level up 
```

Clone the files into this folder by using the command "git clone ***" and replace the "***" with the copied url. Press enter.

  1. Now you have the file containing the SDK. This must be packaged into an APK in order to run on your device. Open the application folder in Android Studio. (File > Open > application folder)

  1. Build APK by selecting Build>Build APK.

  1. Once the APK is packaged, you can find it by navigating to the application folder where it is stored (Application Folder > app > build > outputs > apk > new app package) or by clicking the "Reveal in Finder" link toward the bottom of the event log.

  1. Open terminal. CD into the folder with the APK. An easy way to do this is to type "cd", hit the spacebar, then drag the folder containing the APK into terminal. Then hit the enter key.

  1. Turn on developer's mode on the Android device. You can do this by navigating to Settings>Developer Options. Turn the toggle at the top of the screen to "on".

  2. Connect the device to your computer by either using a USB cable or terminal. To connect the device using terminal, enter the command "adb connect ***" where the asterisks are the IP address of the device. The IP address can be found in Settings>Connections>Wi-Fi>Advanced. The IP address is the last listed item.

  1. Once the device is connected, return to terminal and enter the command "adb devices". This should all Android devices the computer is currently connected to. If you see your devices listed, proceed to the next step. If not, reconnect device until it appears at this step.

  1. While in terminal, enter the command "adb install ***" and replace the asterisks with the .apk file.

  1. The app will be on your device.