Project Setup (iOS)

This guide walks through integrating the Lucra iOS SDK (LucraSDK) into your app and preparing it for Games You Play (GYP), Tournaments, and Sports You Watch.

---

Requirements

• Xcode (latest stable version recommended)

• Swift-based iOS app (UIKit or SwiftUI)

• iOS deployment target that supports Swift Concurrency (async/await)

• Ability to add either:

  • Swift Package Manager dependency, or

  • CocoaPods dependency

---

Installing the SDK

Option 1 – Swift Package Manager

1. In Xcode, open your project.

2. Go to File → Add Packages…

3. Enter the Lucra iOS SDK repository URL:

   https://github.com/Lucra-Sports/lucra-ios-sdk.git

4. Choose the latest release tag.

5. Add the LucraSDK product to the app target(s) that should use Lucra.

Your project will now fetch Lucra as a Swift Package.

---

Option 2 – CocoaPods

If your project already uses CocoaPods:

target 'YourApp' do
  use_frameworks!

  pod 'LucraSDK'
end

Then run:

pod install

Open the generated .xcworkspace and build.

---

App Target Configuration

1. Enable Background Networking (optional but recommended)

Under Signing & Capabilities → Background Modes:

• Enable Background fetch

• Enable Remote notifications (if your app relays real-time Lucra updates)

2. Required Info.plist Permissions

Depending on your Lucra configuration, your app may require:

• Location services permissions

• Camera permissions

• Photo library permissions

• Push notifications capability

Example:

<key>NSLocationWhenInUseUsageDescription</key>
<string>Location is required to verify contest eligibility.</string>
<key>NSCameraUsageDescription</key>
<string>Camera is required to scan Lucra QR codes.</string>

Confirm required permissions with your Lucra representative.

---

Validating Installation

After installation:

1. Build the project — ensure import LucraSDK works.

2. Create a dummy screen that references:

   let client = LucraEnvironment.shared.lucraClient

3. Confirm no module import errors.

You're now ready for initialization in Initialize Client.

---

Creating a Shared LucraClient

import LucraSDK

final class LucraEnvironment {
    static let shared = LucraEnvironment()

    let lucraClient: LucraClient

    private init() {
        lucraClient = LucraClient(
            environment: .sandbox,     // or .production
            apiKey: "YOUR_API_KEY"
        )
    }
}

Access via:

LucraEnvironment.shared.lucraClient