Skip to content

add-apm.md

Latest commit

 

History

History
80 lines (47 loc) · 2.47 KB

add-apm.md

File metadata and controls

80 lines (47 loc) · 2.47 KB
Raw

:::info Note: All of the commands below should be run in a terminal / command prompt in the root directory of your application, generally the level above your source directory. :::

If you don't have an APM project setup, expand the guide below to setup an APM project before installing the extension.

Setup APM

Install APM

If you haven't installed apm follow the install guide on airsdk.dev.

Setup an APM project

You will need an APM project for your application.

There are many ways to do this and for more options see the APM documentation. Here we will just initialise a new empty project:

apm init

Check your github token

We use github to secure our extensions so you must have created a github personal access token and configured apm to use it.

To do this create a token using this guide from github and then set it in your apm config using:

apm config set github_token ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXX

If you don't do this correctly you may find the install will fail.

Install the extension

Install the extension by running:

apm install com.distriqt.AppGroupDefaults

This will download and install the extension, required assets, and all dependencies.

Once complete apm will have created something like the following file structure:

.
|____ ane
| |____ com.distriqt.AppGroupDefaults.ane	# AppGroupDefaults extension
| |____ [dependencies]
|____ apm_packages							# cache directory - ignore
|____ project.apm							# apm project file

  • Add the ane directory to your IDE. See the tutorials located here on adding an extension to your IDE.

  • You will need to set the application group for iOS and Android in order that the application descriptor can be generated correctly for your application. Call the following to step through the configuration values for this extension:

apm project config set com.distriqt.AppGroupDefaults

:::info We suggest you use the locations directly in your builds rather than copying the files elsewhere. The reason for this is if you ever go to update the extensions using apm that these updates will be pulled into your build automatically. :::