Skip to content

loay-ashraf/RxNetworkKit

Repository files navigation

RxNetworkKit

Swift Platforms iOS macOS tvOS watchOS SPM Twitter LinkedIn

RxNetworkKit is a generic reactive networking framework that leverages the stability and reliability of both Apple's URLSession and RxSwift.

To get started with the framework, please refer to the developer documentation.

Requirements

Platform Minimum Swift Version Installation Status
iOS(iPadOS) 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+ 5.3 Swift Package Manager, Manual Fully Tested

Installation

Swift Package Manager

The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler.

Once you have your Swift package set up, adding RxNetworkKit as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/loay-ashraf/RxNetworkKit.git", .upToNextMajor(from: "2.0.0"))
]

Manually

If you prefer not to use any of the aforementioned dependency managers, you can integrate RxNetworkKit into your project manually.

Embedded Framework

  • Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:

    $ git init
  • Add RxNetworkKit as a git submodule by running the following command:

    $ git submodule add https://github.com/loay-ashraf/RxNetworkKit.git
  • Open the new RxNetworkKit folder, and drag the RxNetworkKit.xcodeproj into the Project Navigator of your application's Xcode project.

    It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the RxNetworkKit.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) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

  • 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 one RxNetworkKit.xcodeproj folder with one RxNetworkKit.framework nested inside it.

  • Select the RxNetworkKit.framework.

  • And that's it!

    The RxNetworkKit.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Credits

This project uses the Smart Retry operator from this blog Smart Retry written by Alex Grebenyuk