Skip to main content
Code samples

Installation

NCKit supports three integration methods. Swift Package Manager is recommended for new projects.

Swift Package Manager​

  1. Open your project in Xcode
  2. Go to File β†’ Add Package Dependencies…
  3. Enter the repository URL:
    https://github.com/5Exceptions-Mobile-Team/NCKit.git
  4. Select Exact Version 1.2.1 (recommended)
  5. Click Add Package
  6. In your target's Frameworks, Libraries, and Embedded Content β€” confirm NCKit is set to Embed & Sign

Via Package.swift​

Package.swift
// swift-tools-version: 5.9
import PackageDescription

let package = Package(
name: "YourApp",
platforms: [.iOS(.v15)],
dependencies: [
.package(
url: "https://github.com/5Exceptions-Mobile-Team/NCKit.git",
exact: "1.2.1"
)
],
targets: [
.target(
name: "YourApp",
dependencies: ["NCKit"]
)
]
)

Local Development Path​

If you have NCKit checked out locally alongside your project:

Package.swift
dependencies: [
.package(path: "../NCKit-iOS")
]

CocoaPods​

Add to your Podfile:

Podfile
platform :ios, '15.0'
use_frameworks!

target 'YourApp' do
pod 'NCKit',
:git => 'https://github.com/5Exceptions-Mobile-Team/NCKit.git',
:tag => '1.2.1'
end

Then install:

pod install
open YourApp.xcworkspace

Local Development​

Podfile
pod 'NCKit', :path => '../NCKit-iOS'

Manual β€” XCFramework​

Use this method when you need to distribute NCKit as part of an internal artifact registry (Artifactory, Nexus, etc.).

Steps​

  1. Download NCKit.xcframework.zip from GitHub Releases

  2. Unzip and drag NCKit.xcframework into your Xcode project

  3. In your target settings β†’ General β†’ Frameworks, Libraries, and Embedded Content:

    • Set NCKit.xcframework to Embed & Sign
  4. Verify linked frameworks in Build Phases β†’ Link Binary with Libraries:

    • AVFoundation.framework
    • Accelerate.framework
  5. Import and build:

    import NCKit

Post-Installation Checklist (iOS)​

  • App iOS Deployment Target is 15.0 or higher
  • import NCKit compiles without errors
  • NCKit appears under Frameworks, Libraries, and Embedded Content as Embed & Sign
  • Build succeeds for iOS device target (arm64)
  • Build succeeds for iOS Simulator (arm64 on Apple Silicon, x86_64 on Intel Mac with 1.2.1+)
Simulator architectures

1.2.1+ ships ios-arm64_x86_64-simulator for both Apple Silicon and Intel Mac simulators. See Requirements.

Next steps​

β†’ How to Use β€” copy-paste integration (file denoise)
β†’ Sample App β€” reference project