Skip to content

Adobe Experience Platform - User Profile extension built with Swift

License

Notifications You must be signed in to change notification settings

adobe/aepsdk-userprofile-ios

AEPUserProfile

Cocoapods SPM Build Code Coverage

About this project

The Adobe Experience Platform UserProfile Mobile Extension is an extension for the Adobe Experience Platform SDK.

To learn more about this extension, read Adobe Experience Platform Profile Mobile Extension.

Requirements

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

Installation

# Podfile

use_frameworks!

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

# for extension development, include AEPCore and its dependencies
target 'YOUR_TARGET_NAME' do
    pod 'AEPCore'
    pod 'AEPUserProfile'
end

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

File > Swift Packages > Add Package Dependency...

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

When prompted, input a specific version or a range of versions for Version rule.

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

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

Binaries

To generate an AEPUserProfile.xcframework, run the following command:

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

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.