Swift Package Index

SwiftPhoenixClient

https://github.com/davidstump/SwiftPhoenixClient.git
MIT

Connect your Phoenix and iOS applications through WebSockets!

  • In development for 6 years, with 252 commits and 19 releases.
  • There are 7 open issues and 1 open pull request. The last issue was closed 5 months ago and the last pull request was merged/closed 5 months ago.
  • SwiftPhoenixClient contains 1 library and no executables.
  • 411 stars.
  • The latest stable release is 1.3.0. Released 5 months ago.
  • The last commit to master was 5 months ago.

Swift Version Compatibility

  • 1.3.0 and master
    5.3
    5.2
    5.1
    5.0
    4.2
Full build results

Platform Compatibility

  • 1.3.0 and master
    iOS
    macOS(Intel)
    macOS(ARM)
    Linux
    tvOS
    watchOS
Full build results

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

SwiftPackageManager

SwiftPackageManager is properly supported starting in SwiftPhoenixClient v1.2.0. You can add the following to your Package.swift

.package(url: "https://github.com/davidstump/SwiftPhoenixClient.git", .upToNextMajor(from: "1.2.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 you have used the phoenix.js 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.