Perfect URL Shortener Example

An Example URL Shortener System for Perfect

This project demonstrates the following:

• Mustache templating
• URL routing and handlers
• URL Variables
• Static file serving
• SQLite3 database setup, and search.

This package builds with Swift Package Manager and is part of the Perfect project.

Ensure you have installed Xcode 8.0 or later.

Setup - Xcode 8

• Check out or download the project;
• In terminal, navigate to the directory and execute

swift package generate-xcodeproj

• Open PerfectURLShortener.xcodeproj

Due to the complexity of running static file serving from Xcode, we suggest running this project from Terminal.

Optionally, to run from within Xcode, edit the Scheme, Under "Options" for "run", check "Use custom working directory" and choose the project's working directory. After doing this, the project can be run from within Xcode.

NOTE: Due to a late-breaking bug in Xcode 8, if you wish to run directly within Xcode, we recommend installing swiftenv and installing the Swift 3.0.1 preview toolchain.

# after installing swiftenv from https://swiftenv.fuller.li/en/latest/
swiftenv install https://swift.org/builds/swift-3.0.1-preview-1/xcode/swift-3.0.1-PREVIEW-1/swift-3.0.1-PREVIEW-1-osx.pkg

Setup - Terminal

• Check out or download the project;
• In terminal, navigate to the directory
• Execute swift build
• Once the project has compiled, execute ./.build/debug/PerfectURLShortener

[INFO] Starting HTTP server on 0.0.0.0:8181 with document root ./webroot

Routes

• http://localhost:8181 - Form input and display of existing entries.
• http://localhost:8181/to/{shortcut} - Will redirect to the allocated URL.

Issues

We are transitioning to using JIRA for all bugs and support related issues, therefore the GitHub issues has been disabled.

If you find a mistake, bug, or any other helpful suggestion you'd like to make on the docs please head over to http://jira.perfect.org:8080/servicedesk/customer/portal/1 and raise it.

A comprehensive list of open issues can be found at http://jira.perfect.org:8080/projects/ISS/issues

Further Information

For more information on the Perfect project, please visit perfect.org.