/KituraKit

Swift client library for using Codable routes with Kitura

Primary LanguageSwiftApache License 2.0Apache-2.0

KituraKit - A Kitura v2 Client Library

Build Status macOS Linux

Kitura is a lightweight web framework for creating complex web routes for web applications.

KituraKit allows developers to use the Swift 4 Codable protocol in their front and back end applications and use the same code on the front and backend.

Usage

Cocoapod Installation

Using an existing Podfile

  1. Open your Podfile with your preferred text editor

  2. Find the list of your currently installed pods and add to that list the following:

pod 'KituraKit', :git => 'https://github.com/IBM-Swift/KituraKit.git', :branch => 'pod'
  1. Run pod install to install KituraKit.

Creating a new Podfile

  1. Navigate to the root of your project (where your .xcodeproj directory is)

  2. Run pod init This will create a Podfile in your current directory.

  3. Open the Podfile with your preferred text editer and under the "# Pods for 'your_project_name'>" line add:

pod 'KituraKit', :git => 'https://github.com/IBM-Swift/KituraKit.git', :branch => 'pod'
  1. Install KituraKit by running the command: pod install

  2. As well as installing KituraKit the pod install also creates an Xcode workspace which contains all of your installed pods. So you'll need to open the .xcworkspace (not .xcodeproj) to have access to those pods. This is the default behaviour of Cocoapods.

Examples

To run through a FoodTracker tutorial which covers various components of Kitura, including KituraKit, click here

To try out the sample iOS project for yourself, making use of KituraKit, click here.

Swift version

The 0.0.x releases were tested on macOS and Linux using the Swift 4.0.3 binary. Please note that this is the default version of Swift that is include in Xcode 9.2.

Community

We love to talk server-side Swift and Kitura. Join our Slack to meet the team!