/aepsdk-target-ios

Adobe Experience Platform - Target extension built with Swift

Primary LanguageSwiftApache License 2.0Apache-2.0

AEPTarget

SPM Target-CI Code Coverage

About this project

The AEPTarget helps test, personalize, and optimize mobile app experiences based on user behavior and mobile context. You can deliver interactions that engage and convert through iterative testing and rules-based and AI-powered personalization.

Requirements

  • Xcode 11.0 (or newer)
  • Swift 5.1 (or newer)

Installation

CocoaPods

# Podfile
use_frameworks!

# for app development, include all the following pods
target 'YOUR_TARGET_NAME' do
    pod 'AEPTarget'
    pod 'AEPCore'
end

Swift Package Manager

To add the AEPTarget Package to your application, from the Xcode menu select:

File > Swift Packages > Add Package Dependency...

Enter the URL for the AEPTarget package repository: https://github.com/adobe/aepsdk-target-ios.git.

When prompted, specify the Version rule using a specific version range or an exact version.

Alternatively, if your project has a Package.swift file, you can add AEPTarget directly to your dependencies:

dependencies: [
    .package(url: "https://github.com/adobe/aepsdk-target-ios.git", .upToNextMajor(from: "3.1.3")),
],
targets: [
    .target(name: "YourTarget",
            dependencies: ["AEPTarget"],
	    path: "your/path")
]

Binaries

Run the following command, from the project root directory, to generate the AEPTarget.xcframework in the build directory. But, first run make pod-install command to ensure the dependencies are installed.

make archive

Development

The first time you clone or download the project, you should run the following from the root directory to setup the environment:

make pod-install

Subsequently, you can make sure your environment is updated by running the following:

make pod-update

Open the Xcode workspace

Open the workspace in Xcode by running the following command from the root directory of the repository:

make open

Command line integration

You can run all the test suites from command line:

make test

Documentation

Additional documentation for API usage can be found under the Documentation directory.

Contributing

Contributions are welcomed! Read the Contributing Guide for more information.

Licensing

This project is licensed under the Apache V2 License. See LICENSE for more information.