Skip to content

Latest commit

 

History

History
296 lines (191 loc) · 9.15 KB

README.md

File metadata and controls

296 lines (191 loc) · 9.15 KB
Raw

Kitura

A Swift Web Framework and HTTP Server

Build Status - Master macOS Linux Apache 2 Join the chat at https://gitter.im/IBM-Swift/Kitura

Summary

Kitura is a web framework and web server that is created for web services written in Swift.

Table of Contents

Features

  • URL routing (GET, POST, PUT, DELETE)
  • URL parameters
  • Static file serving
  • FastCGI support
  • JSON parsing
  • Pluggable middleware

Swift version

Version 0.28 of Kitura requires the DEVELOPMENT-SNAPSHOT-2016-08-23-a version of Swift 3 trunk (master). You can download this version at swift.org. Kitura is unlikely to compile with any other version of Swift.

Installation

macOS

  1. Install Homebrew (if you don't already have it installed):

$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

  1. Install the necessary dependencies:

$ brew install curl

  1. Download and install Xcode 8 beta 6.

  2. Download and install the required Swift version from swift.org.

During installation if you are using the package installer make sure to select "all users" for the installation path in order for the correct toolchain version to be available for use with the terminal.

After installation, make sure you update your PATH environment variable as described in the swift.org installation instructions (e.g. export PATH=/Library/Developer/Toolchains/swift-latest.xctoolchain/usr/bin:$PATH)

  1. Select the Xcode beta as your active developer directory.

$ sudo xcode-select -s /Applications/Xcode-beta.app/Contents/Developer/

Now you are ready to develop your first Kitura app. Check Kitura-Sample or see Getting Started.

Ubuntu Linux

Kitura is tested on Ubuntu 14.04 LTS and Ubuntu 15.10.

  1. Install the following system linux libraries:

$ sudo apt-get install libcurl4-openssl-dev uuid-dev

  1. Install the required Swift version from swift.org.

After installing it (i.e. extracting the .tar.gz file), make sure you update your PATH environment variable so that it includes the extracted tools: export PATH=/<path to uncompress tar contents>/usr/bin:$PATH.

Now you are ready to develop your first Kitura app. Check Kitura-Sample or see Getting Started.

Docker

  1. Install Docker on your development system.

  2. Pull down the kitura-ubuntu image from Docker Hub:

$ docker pull ibmcom/kitura-ubuntu:latest

  1. Create a Docker container using the kitura-ubuntu image you just downloaded and forward port 8090 on host to the container:

$ docker run -i -p 8090:8090 -t ibmcom/kitura-ubuntu:latest /bin/bash

  1. From within the Docker container, execute the clone_build_kitura.sh script to build the Kitura-Starter-Bluemix sample project:

# /root/clone_build_kitura.sh

The last two output lines from executing the clone_build_kitura.sh script should be similar to:

Linking .build/debug/Kitura-Starter-Bluemix
>> Build for Kitura-Starter-Bluemix completed (see above for results).
  1. You can now run the Kitura-Starter-Bluemix executable inside the Docker container:

# /root/start_kitura_sample.sh

You should see an output message that contains the string Listening on port 8090.

Vagrant

  1. Install VirtualBox.

  2. Install Vagrant.

  3. From the root of the Kitura folder containing the vagrantfile, create and configure a guest machine:

$ vagrant up

  1. SSH into the Vagrant machine:

$ vagrant ssh

  1. As needed for development, edit the vagrantfile to setup Synced Folders to share files between your host and guest machine.

Now you are ready to develop your first Kitura app. Check Kitura-Sample or see Getting Started.

Getting Started

Let's develop your first Kitura web application!

  1. First, create a new project directory.
$ mkdir myFirstProject
  1. Next, create a new Swift project using the Swift Package Manager.
$ cd myFirstProject
$ swift package init --type executable

Now your directory structure under myFirstProject should look like this:

  myFirstProject
  ├── Package.swift
  ├── Sources
  │   └── main.swift
  └── Tests
      └── empty

Note: For more information on the Swift Package Manager, go here.

  1. In Package.swift, add Kitura as a dependency for your project.
import PackageDescription

let package = Package(
    name: "myFirstProject",
    dependencies: [
        .Package(url: "https://github.com/IBM-Swift/Kitura.git", majorVersion: 0, minor: 28)
    ])
  1. In Sources/main.swift, import the Kitura module.
import Kitura
  1. Add a router and a path:
let router = Router()

router.get("/") {
    request, response, next in
    response.send("Hello, World!")
    next()
}
  1. Add an HTTP server and start the Kitura framework.
Kitura.addHTTPServer(onPort: 8090, with: router)
Kitura.run()
  1. Your Sources/main.swift file should now look like this.
import Kitura

let router = Router()

router.get("/") {
    request, response, next in
    response.send("Hello, World!")
    next()
}

Kitura.addHTTPServer(onPort: 8090, with: router)
Kitura.run()

  1. Optionally, add logging.

    In the code example above, no messages from Kitura will logged. You may want to add a logger to help diagnose any problems that occur.

    Add a HeliumLogger dependency to Package.swift.

    import PackageDescription

let package = Package(
    name: "myFirstProject",
    dependencies: [
        .Package(url: "https://github.com/IBM-Swift/Kitura.git", majorVersion: 0, minor: 28),
        .Package(url: "https://github.com/IBM-Swift/HeliumLogger.git", majorVersion: 0, minor: 15)
    ])

    Enable HeliumLogger in Sources/main.swift.

    import HeliumLogger

HeliumLogger.use()

    Here is the finished Sources/main.swift file.

    import Kitura
import HeliumLogger

HeliumLogger.use()

let router = Router()

router.get("/") {
    request, response, next in
    response.send("Hello, World!")
    next()
}

Kitura.addHTTPServer(onPort: 8090, with: router)
Kitura.run()

  2. Compile your application:

$ swift build

Or copy our Makefile and build scripts to your project directory and run make build. You may want to customize this Makefile and use it for building, testing and running your application. For example, you can clean your build directory, refetch all the dependencies, build, test and run your application by running make clean refetch test run.

  1. Now run your new web application:

$ .build/debug/myFirstProject

  1. Open your browser at http://localhost:8090

Contributing to Kitura

All improvements to Kitura are very welcome! Here's how to get started with developing Kitura itself.

  1. Clone this repository.

$ git clone https://github.com/IBM-Swift/Kitura

  1. Build and run tests.

$ make test

Notes

  • Homebrew by default installs libraries to /usr/local, if yours is different, change the path to find the curl library, in Package-Builder/build/Makefile:

    SWIFTC_FLAGS = -Xswiftc -I/usr/local/include
LINKER_FLAGS = -Xlinker -L/usr/local/lib

You can find more info on contributing to Kitura in our contributing guidelines.

Community

We love to talk server-side Swift, and Kitura. Join our chat channel on Gitter to meet the team!