This sample server-side todo app in swift provides a nice and clean code to get started with IBMs Kitura.
This application has been generated with the following capabilities and services:
This application uses the SwiftMetrics package to gather application and system metrics.
These metrics can be viewed in an embedded dashboard on /swiftmetrics-dash. The dashboard displays various system and application metrics, including CPU, memory usage, HTTP response metrics and more.
The application includes the following files for Docker support:
.dockerignoreDockerfileDockerfile-tools
The .dockerignore file contains the files/directories that should not be included in the built docker image. By default this file contains the Dockerfile and Dockerfile-tools. It can be modified as required.
The Dockerfile defines the specification of the default docker image for running the application. This image can be used to run the application.
The Dockerfile-tools is a docker specification file similar to the Dockerfile, except it includes the tools required for compiling the application. This image can be used to compile the application.
Details on how to build the docker images, compile and run the application within the docker image can be found in the Run section below.
This application uses the Kitura-CouchDB package, which allows Kitura applications to interact with a CouchDB database.
CouchDB speaks JSON natively and supports binary for all your data storage needs.
Boilerplate code for creating a client object for the Kitura-CouchDB API is included inside Sources/Application/Application.swift as an internal variable available for use anywhere in the Application module.
The connection details for this client are loaded by the configuration code and are passed to the Kitura-CouchDB client in the boilerplate code.
This project only holds one model. The model is called Todo and is added as a struct in swift.
struct Todo {
public static var type: String {
return "todo"
}
let id: String
let title: String
let createdAt: UInt
let updatedAt: UInt
var json: JSON {
return JSON([
"type": Todo.type,
"id": id,
"title": title,
"createdAt": createdAt,
"updatedAt": updatedAt
])
}
}Configured Routes are:
http://localhost:8080/http://localhost:8080/swiftmetrics-dashhttp://localhost:8080/healthhttp://localhost:8080/todoshttp://localhost:8080/todos/:idhttp://localhost:8080/todos
All routes are GET routes but the last one, which is a POST route. Routes are defined in Sources/Application/Routes.
Your application configuration information is stored in the config.json in the project root directory. This file is in the .gitignore to prevent sensitive information from being stored in git.
The connection information for any configured services, such as username, password and hostname, is stored in this file.
The application uses the Configuration package to read the connection and configuration information from this file.
To build and run the application:
swift build.build/debug/todoApp
NOTE: On macOS you will need to add options to the swift build command: swift build -Xlinker -lc++
To build the two docker images, run the following commands from the root directory of the project:
docker build -t myapp-run .docker build -t myapp-build -f Dockerfile-tools .You may customize the names of these images by specifying a different value after the-toption.
To compile the application using the tools docker image, run:
docker run -v $PWD:/root/project -w /root/project myapp-build /root/utils/tools-utils.sh build release
To run the application:
docker run -it -p 8080:8080 -v $PWD:/root/project -w /root/project myapp-run sh -c .build-ubuntu/release/todoApp
All generated content is available for use and modification under the permissive MIT License (see LICENSE file), with the exception of SwaggerUI which is licensed under an Apache-2.0 license (see NOTICES.txt file).
This project was generated with generator-swiftserver v2.7.0.