Installation

Last Edit: Sep 25 2020

StreamChat Swift SDK supports:

  • iOS 11 and up

  • MacOS 10.15 and up

StreamChat SDK consists of three frameworks: StreamChatStreamChatCore and StreamChatClient

  • StreamChatClient - the low-level library that connects & communicates with StreamChat backend.

  • StreamChatCore — building on top of StreamChatClient, it includes models, presenters, and notification manager. Additionally, it has RxSwift support for reactive programming.

  • StreamChat — building on top of Core, it's the full SDK library with all UI components. Styling and deep customizations are all supported out of the box.

CocoaPods

To integrate StreamChat into your Xcode project using CocoaPods, add this entry in your Podfile:


pod 'StreamChat'
                    

Then run pod install.

If you want to use only StreamChatCore, or StreamChatClient, you can add this entry in your Podfile:


pod 'StreamChatCore'
# or
pod 'StreamChatClient'
                    

In any file you'd like to use Stream Chat in, don't forget to import the necessary library:


import StreamChat
// or
import StreamChatCore
// or
import StreamChatClient
// or all 3
                    

Carthage

To integrate Stream Chat into your Xcode project using Carthage, specify it in your Cartfile:


github "GetStream/stream-chat-swift"
                    

Then run: carthage update --platform iOS --new-resolver. It will build the frameworks: StreamChatClient.frameworkStreamChatCore.framework and StreamChat.framework into <Path to your Project>/Carthage/Build/iOS/ from where you can add them to your project and link them with your app target.

Follow with these steps:

  • Open your Xcode project

  • Select the project in the Navigator

  • Select your app target

  • Open General panel

  • Open <Path to your Project>/Carthage/Build/iOS/ in Finder and find StreamChatClient.framework, drag and drop it into Frameworks, Libraries, and Embedded Content area in Xcode. Do the same for StreamChatCore.framework and StreamChat.framework if you need UI components.

  • After adding libraries, select "Do Not Embed" option in "Embed" section. (Right next to the library name after adding it)

  • Open Build Phases panel in Xcode

  • Click the + button and select New Run Script Phase

  • Set the content to: /usr/local/bin/carthage copy-frameworks

  • Add to Input Files:

    • $(SRCROOT)/Carthage/Build/iOS/StreamChatClient.framework

    • $(SRCROOT)/Carthage/Build/iOS/Starscream.framework

    • if you need Core library:

      • $(SRCROOT)/Carthage/Build/iOS/StreamChatCore.framework

      • $(SRCROOT)/Carthage/Build/iOS/RxSwift.framework

      • $(SRCROOT)/Carthage/Build/iOS/RxCocoa.framework

      • $(SRCROOT)/Carthage/Build/iOS/RxRelay.framework

    • if you need UI components:

      • $(SRCROOT)/Carthage/Build/iOS/StreamChat.framework

      • $(SRCROOT)/Carthage/Build/iOS/Nuke.framework

      • $(SRCROOT)/Carthage/Build/iOS/SnapKit.framework

      • $(SRCROOT)/Carthage/Build/iOS/SwiftyGif.framework

      • $(SRCROOT)/Carthage/Build/iOS/RxGesture.framework

  • Add to Output Files:

    • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/StreamChatClient.framework

    • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/Starscream.framework

    • if you need Core library:

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/StreamChatCore.framework

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/RxSwift.framework

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/RxCocoa.framework

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/RxRelay.framework

    • if you need UI components:

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/StreamChat.framework ()

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/Nuke.framework

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/SnapKit.framework

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/SwiftyGif.framework

      • $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/RxGesture.framework

Now you can build your app and use StreamChat.

Swift Package Manager

You can directly add dependency in Xcode 11+ using repo url, or in your Package.swift file, add to dependencies:


.package(url:'https://github.com/GetStream/stream-chat-swift.git', from: '2.1'),