
Being perfectionists, we took the best from what we think is the best: power of Play Framework and simplicity of Express.js
Swift Express is an asynchronous, simple, powerful, yet unopinionated web application server written in Swift
Usage
Create new project
This one creates a brand new initialized project, ready to use out of the box.
swift-express init YourProject
swift-express init has a few optional parameters:
--template git-urlallows specifying the project template git URL. Defaults tohttps://github.com/crossroadlabs/ExpressTemplate.git.--path path/to/dirspecifies where to create the application. Defaults to the current directory.
Initialise project dependencies
To download and build project dependencies call bootstrap command:
Optional parameters:
--spmuse Swift Package Manager instead of Carthage. Is default on Linux.--carthageuse Carthage as package manager. Is default for OS X. Not available on Linux.--fetchfetch dependencies without building. Default is false. Always true for SPM as it has no separate build dependencies option.--no-refetchbuild dependencies without fetching. Default is false. Always false for SPM.--path path/to/the/appcan be used outside the app's folder explicitly specifying the path to the app.
Update project dependencies
To update project dependencies according to Cartfile or Package.swift call update command:
Optional parameters:
--spmuse Swift Package Manager instead of Carthage. Is default on Linux.--carthageuse Carthage as package manager. Is default for OS X. Not available on Linux.--fetchfetch dependencies without building. Default is false. Always true for SPM as it has no separate build dependencies option.--path path/to/the/appcan be used outside the app's folder explicitly specifying the path to the app.
Build project
Command line build interface for Swift Express projects.
Build configuration can be specified like this:
swift-express build release
Default configuration is debug
Optional parameters:
--spmuse Swift Package Manager as build tool. Is default on Linux.--xcodeuse Xcode as build tool. Is default for OS X. Not available on Linux.--dispatchbuild with Dispatch support. Is default on OS X.--forceforce rebuild. Essentially cleans before building.--path path/to/the/appcan be used outside the app's folder explicitly specifying the path to the app.
Run the app
Command line interface for running Swift Express apps.
Build configuration can be specified like this:
swift-express run release
Default configuration is debug
Optional parameters:
--spmrun app built by Swift Package Manager. Is default on Linux.--xcoderun app built by Xcode. Is default for OS X. Not available on Linux.--path path/to/the/appcan be used outside of the app's folder explicitly specifying the path to the app.
Print help
This one prints short documentation for all the commands available.
Also can print short documentation for command
swift-express help bootstrapInstallation
Please refer to the main Swift Express article here: https://github.com/crossroadlabs/Express/blob/master/doc/gettingstarted/installing.md
Changelog
- v0.2: Swift Package Manager support.
- v0.1: Initial Public Release
Contributing
To get started, sign the Contributor License Agreement.