Table of Contents

• Goal📈
• Contributing
• Requirements
• Code of Conduct
• What's Next
• Contact
• Apps using this library
• License

Goals

• Provide a 🚨safe🚨 environment for others to learn and grow through Open Source.
• Make adding Chat:speech_balloon: to a project easy.
• Enable beautiful and customizable Chat UI's.
• Provide an awesome Open Source project for the iOS open source community.
• Help others learn.

Vision

See VISION.md for Goals, Scope, & Technical Considerations.

Installation

CocoaPods Recommended

pod 'MessageKit'

If your project is still using Swift 3, you can add the following code to your Podfile:

target 'TARGET_NAME' do
    pod 'MessageKit'
    ...
    post_install do |installer|
        installer.pods_project.targets.each do |target|
            if target.name == 'MessageKit'
                target.build_configurations.each do |config|
                    config.build_settings['SWIFT_VERSION'] = '4.0'
                end
            end
        end
    end
end

Carthage

To integrate MessageKit using Carthage, add the following to your Cartfile:

github "MessageKit/MessageKit"

Manual

Embedded Framework

• cd to your project directory, initialize git, and Add MessageKit as a git submodule by running the following command:

  $ git submodule add https://github.com/MessageKit/MessageKit.git

• cd to the new MessageKit folder and trigger carthage update by the following command:

  $ carthage update --platform iOS

• Open MessageKit folder, and drag the MessageKit.xcodeproj into the Project Navigator of your application's Xcode project. It should appear nested underneath your application's blue project icon.

• Select the MessageKit.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

• Next, select your application project in the Project Navigator (blue project icon), navigate to the target configuration window and select the application target.

• In the tab bar at the top of that window, open the "General" panel.

• Click on the + button under the "Embedded Binaries" section.

• You will see two different MessageKit.xcodeproj folders each with two different versions of the MessageKit.framework nested inside a Products folder.

• Select the top MessageKit.framework for iOS and the bottom one for OS X.

• Voila! Now you can import MessageKit and build the project.

Getting Started

Please have a look at the Quick Start guide, the FAQs and the MessageInputBar docs.

If you have any issues have a look at the Example project or write a question with the "messagekit" tag on Stack Overflow.

Requirements

• iOS9 or later

Contributing

Great! Look over these things first.

• Please read our Code of Conduct
• Check the Contributing Guide Lines.
• Come join us on Slack and 🗣 don't be a stranger.
• Check out the current issues and see if you can tackle any of those.
• Download the project and check out the current code base. Suggest any improvements by opening a new issue.
• Check out the What's Next section 👇 to see where we are headed.
• Check StackOverflow
• Install SwiftLint too keep yourself in style.
• Be kind and helpful.

What's Next?

Check out the Releases to see what we are working on next.

Contact

Have a question or an issue about MessageKit? Create an issue!

Interested in contributing to MessageKit? Click here to join our Slack.

Apps using this library

Add your app to the list of apps using this library and make a pull request.

• Formacar
• HopUp
• MediQuo
• RappresentaMe
• WiseEyes

Please provide attribution, it is greatly appreciated.

Core Team

• @SD10, Steven Deutsch
• @nathantannar4, Nathan Tannar
• @zhongwuzw, Wu Zhong

Thanks

Many thanks to the contributors of this project.

License

MessageKit is released under the MIT License.

Inspiration

Inspired by JSQMessagesViewController 👈 💯