Swift client library for using Codable routes with Kitura
Clone or download
Latest commit a8cae44 Jul 9, 2018

README.md

Kitura

APIDoc Build Status - Master macOS Linux Apache 2 Slack Status

KituraKit - A Kitura v2 Client Library

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:

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 (the directory containing your .xcodeproj file).

  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 file (not .xcodeproj) to have access to those pods. This is the default behaviour of Cocoapods.

SPM Installation

We expect users on the client side to use the Cocoapod installation, however, if you require access to KituraKit from the server you can use Swift Package Manager.

Add dependencies

Add the KituraKit package to the dependencies within your application’s Package.swift file. Substitute "x.x.x" with the latest KituraKit release.

.package(url: "https://github.com/IBM-Swift/KituraKit.git", from: "x.x.x")

Add KituraKit to your target's dependencies:

.target(name: "example", dependencies: ["KituraKit"]),

Import package

import KituraKit

Examples

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

To try out a sample iOS project yourself, which makes use of KituraKit, click here.

API Documentation

For more information visit our API reference.

Community

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

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.