How helpscout/beacon-ios-sdk works
Project type and purpose
• This is not a standalone app but an iOS SDK: Beacon SDK (distributed as an XCFramework) that you embed in your iOS app to provide Help Scout’s knowledge-base browsing and chat/feedback functionality.
• The README confirms this: it describes installation via CocoaPods, Swift Package Manager, Carthage (deprecated), or manual integration. It also references two example apps (Objective-C and SwiftUI) that demonstrate usage.
File structure
• Top-level artifacts
• Beacon.xcframework: the compiled binary for multiple architectures (ios-arm64, ios-simulator, etc.), containing:
– Framework bundles with UI resources (storyboards and nibs)
– Public headers (Beacon.h, HSBeacon.h, constants, models)
– Private headers (HSBeacon* classes, API clients, view controllers, utilities)
• Package.swift, Beacon.podspec, Cartfile/Cartfile.resolved: build/distribution manifests
• Examples/…: two sample apps showing how your host app integrates the SDK
• docs/: auto-generated API reference for public classes, enums, protocols
• UI resources (storyboards, nibs, CSS/JS for web content)
• Public API surface (public headers & Swift module interfaces)
• Private implementation headers (network clients, coordinators, view controllers, utilities)
• Third-party dependencies embedded as private headers: Starscream (WebSockets), PusherSwift, Reachability, Gifu, FBShimmering
README for additional insights
• “Beacon functionality we have for the web inside your iOS app”
• Need to configure email attachments and push notifications (so there’s a network & push layer)
• Examples showcase delegate points and configuration in SettingsView.swift (SwiftUI example) and HSExampleViewController in Obj-C.