shalehaha/aepsdk-core-ios-1

AEPCore

BETA ACKNOWLEDGEMENT

AEPCore is currently in Beta. Use of this code is by invitation only and not otherwise supported by Adobe. Please contact your Adobe Customer Success Manager to learn more.

By using the Beta, you hereby acknowledge that the Beta is provided "as is" without warranty of any kind. Adobe shall have no obligation to maintain, correct, update, change, modify or otherwise support the Beta. You are advised to use caution and not to rely in any way on the correct functioning or performance of such Beta and/or accompanying materials.

About this project

The Mobile Core represents the core Adobe Experience Platform SDK that is required for every app implementation. The core contains a common set of functionality and frameworks, such as Experience Cloud Identity services, data event hub, Rules Engine, reusable networking, disk access routines, and so on, which are required by all Adobe and third-party extensions.

Requirements

• Xcode 11.x
• Swift 5.x

Installation

These are currently the supported installation options:

CocoaPods

# Podfile
use_frameworks!

# for app development, include all the following pods
target 'YOUR_TARGET_NAME' do
    pod 'AEPServices', :git => '[email protected]:adobe/aepsdk-core-ios.git', :branch => 'main'
    pod 'AEPCore', :git => '[email protected]:adobe/aepsdk-core-ios.git', :branch => 'main'
    pod 'AEPLifecycle', :git => '[email protected]:adobe/aepsdk-core-ios.git', :branch => 'main'
    pod 'AEPIdentity', :git => '[email protected]:adobe/aepsdk-core-ios.git', :branch => 'main'
    pod 'AEPRulesEngine', :git => '[email protected]:adobe/aepsdk-rulesengine-ios.git', :branch => 'dev'
end

# for extension development, include AEPCore and its dependencies
target 'YOUR_TARGET_NAME' do
    pod 'AEPCore', :git => '[email protected]:adobe/aepsdk-core-ios.git', :branch => 'main'
    pod 'AEPServices', :git => '[email protected]:adobe/aepsdk-core-ios.git', :branch => 'main'
    pod 'AEPRulesEngine', :git => '[email protected]:adobe/aepsdk-rulesengine-ios.git', :branch => 'dev'
end

Replace YOUR_TARGET_NAME and then, in the Podfile directory, type:

$ pod install

Swift Package Manager

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

File > Swift Packages > Add Package Dependency...

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

When prompted, make sure you change the branch to main. (Once the repo is public, we will reference specific tags/versions instead of a branch)

There are three options for selecting your dependencies as identified by the suffix of the library name:

• "Dynamic" - the library will be linked dynamically
• "Static" - the library will be linked statically
• (none) - (default) SPM will determine whether the library will be linked dynamically or statically

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

dependencies: [
    .package(url: "https://github.com/adobe/aepsdk-core-ios.git", .branch("main"))
]

Project Reference

Include AEPCore.xcodeproj in the targeted Xcode project and link all necessary libraries to your app target.

Binaries

Run make archive from the root directory to generate .xcframeworks for each module under the build folder. Drag and drop all .xcframeworks to your app target in Xcode.

Documentation

Additional documentation for usage and SDK architecture can be found under the Documentation directory.

Related Projects

AEP SDK Sample App for iOS contains iOS sample apps for the AEP SDK. Examples are provided for both Objective-c and Swift implementation.

AEP SDK Sample Extension for iOS contains a sample implementation of an iOS extension for the AEP SDK. Example implementations are provided for both Objective-c and Swift.

AEP SDK Compatibility for iOS contains code that bridges ACPCore and 3rd party extension implementations into the AEP SDK runtime.

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.