Latest 1.1.0
Homepage https://github.com/davidstump/SwiftPhoenixClient
License MIT
Platforms ios 9.0, requires ARC
Dependencies Starscream
Authors

Swift Phoenix Client

Swift
Version
License
Platform
Carthage compatible
Open Source Helpers

About

Swift Phoenix Client is an extension of Starscream websocket client library
that makes it easy to connect to Phoenix sockets in a similar manner to the
phoenix.js client.

The client is currently updated to mirror phoenix.js 1.4.

Swift Versions

master currently supports Swift 5.0. You’ll need to set your target to = 1.0.1 if your project is using Swift 4.2

swift client
4.2 1.0.1
5.0 1.1.0

Installation

CocoaPods

You can install SwiftPhoenix Client via CocoaPods by adding the following to your
Podfile. Keep in mind that in order to use Swift Phoenix Client, the minimum iOS
target must be ‘9.0’

platform :ios, '9.0'
use_frameworks!

pod "SwiftPhoenixClient", '~> 1.0'

and running pod install. From there you will need to add import SwiftPhoenixClient in any class you want it to be used.

Carthage

If you use Carthage to manage your dependencies, simply add
SwiftPhoenixClient to your Cartfile:

github "davidstump/SwiftPhoenixClient" ~> 1.0

Make sure you have added SwiftPhoenixClient.framework, and Starscream.framework to the "Linked Frameworks and Libraries" section of your target, and have included them in your Carthage framework copying build phase.

Usage

Using the Swift Phoenix Client is extremely easy (and familiar if have used the phoenix.s client).

See the Usage Guide for details instructions. You can also check out the documentation

Example

Check out the ViewController in this repo for a brief example of a simple iOS chat application using the Phoenix Chat Example

Also check out both the Swift and Elixir channels on IRC.

Development

Check out the wiki page for getting started

Tested with the Phoenix Chat Server example, upgraded to Phoenix 1.2.

Thanks

Many many thanks to Daniel Rees for his many contributions and continued maintenance of this project!

License

SwiftPhoenixClient is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "SwiftPhoenixClient",
    "version": "1.1.0",
    "summary": "Connect your Phoenix and iOS applications through WebSockets!",
    "swift_versions": "5.0",
    "description": "This is the SwiftPhoenixClient, an iOS libaray that works with thenPhoenix Framework's channels. The Phoenix Framework only ships with anJavascript client. Use this library to talk to your Phoenix app fromnyour iOS project. Check out the included chat client example, whichnworks with the Phoenix chat server example:nhttps://github.com/chrismccord/phoenix_chat_examplennThis library implements Phoenix Channels on iOS. For more informationnon Phoenix Channels check out the guide:nhttp://www.phoenixframework.org/docs/channels",
    "homepage": "https://github.com/davidstump/SwiftPhoenixClient",
    "license": "MIT",
    "authors": {
        "David Stump": "[email protected]"
    },
    "source": {
        "git": "https://github.com/davidstump/SwiftPhoenixClient.git",
        "tag": "1.1.0"
    },
    "platforms": {
        "ios": "9.0"
    },
    "requires_arc": true,
    "source_files": "Sources/**/*.swift",
    "dependencies": {
        "Starscream": [
            "~> 3.1.0"
        ]
    },
    "swift_version": "5.0"
}

Pin It on Pinterest

Share This