Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/brightdigit/sublimationvapor

Using Sublimation as a LifecycleHandler for Vapor.
https://github.com/brightdigit/sublimationvapor

developer-tools development-environment server-side-swift swift vapor

Last synced: about 2 months ago
JSON representation

Using Sublimation as a LifecycleHandler for Vapor.

Host: GitHub
URL: https://github.com/brightdigit/sublimationvapor
Owner: brightdigit
License: mit
Created: 2024-08-21T18:32:39.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-08-29T16:03:48.000Z (6 months ago)
Last Synced: 2024-12-31T04:22:20.748Z (about 2 months ago)
Topics: developer-tools, development-environment, server-side-swift, swift, vapor
Language: Shell
Homepage:
Size: 88.9 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


    



SublimationVapor


Using [Sublimation](https://github.com/brightdigit/Sublimation) as a [LifecycleHandler](https://docs.vapor.codes/advanced/services/#lifecycle) for [Vapor](https://vapor.codes).

[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/brightdigit/SublimationVapor/documentation)

[![SwiftPM](https://img.shields.io/badge/SPM-Linux%20%7C%20iOS%20%7C%20macOS%20%7C%20watchOS%20%7C%20tvOS-success?logo=swift)](https://swift.org)

[![Twitter](https://img.shields.io/badge/[email protected]?style=flat)](http://twitter.com/brightdigit)

![GitHub](https://img.shields.io/github/license/brightdigit/SublimationVapor)

![GitHub issues](https://img.shields.io/github/issues/brightdigit/SublimationVapor)

![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/brightdigit/SublimationVapor/SublimationVapor.yml?label=actions&logo=github&?branch=main)

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbrightdigit%2FSublimationVapor%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/brightdigit/SublimationVapor)

[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Fbrightdigit%2FSublimationVapor%2Fbadge%3Ftype%3Dplatforms)](https://swiftpackageindex.com/brightdigit/SublimationVapor)

[![Codecov](https://img.shields.io/codecov/c/github/brightdigit/SublimationVapor)](https://codecov.io/gh/brightdigit/SublimationVapor)

[![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/brightdigit/SublimationVapor)](https://www.codefactor.io/repository/github/brightdigit/SublimationVapor)

[![codebeat badge](https://codebeat.co/badges/a0c6c5c9-4718-499d-9533-725572908e17)](https://codebeat.co/projects/github-com-brightdigit-SublimationVapor-main)

[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/brightdigit/SublimationVapor)](https://codeclimate.com/github/brightdigit/SublimationVapor)

[![Code Climate technical debt](https://img.shields.io/codeclimate/tech-debt/brightdigit/SublimationVapor?label=debt)](https://codeclimate.com/github/brightdigit/SublimationVapor)

[![Code Climate issues](https://img.shields.io/codeclimate/issues/brightdigit/SublimationVapor)](https://codeclimate.com/github/brightdigit/SublimationVapor)\

# Table of Contents

* [Table of Contents](#table-of-contents)

* [Requirements](#requirements)

* [Installation](#installation)

* [Usage](#usage)

* [Documentation](#documentation)

* [License](#license)

# Requirements 

**Apple Platforms**

- Xcode 16.0 or later

- Swift 6.0 or later

- iOS 17 / watchOS 10.0 / tvOS 17 / macOS 14 or later deployment targets

**Linux**

- Ubuntu 20.04 or later

- Swift 6.0 or later

# Installation

To integrate **SublimationVapor** into your app using SPM, specify it in your Package.swift file:

```swift    

let package = Package(

  ...

  dependencies: [

    .package(url: "https://github.com/brightdigit/SublimationVapor.git", from: "1.0.0")

  ],

  targets: [

      .target(

          name: "YourServerApp",

          dependencies: [

            .product(name: "SublimationVapor", package: "SublimationVapor"), ...

          ]),

      ...

  ]

)

```

# Usage

For [Vapor](https://vapor.codes), you add it to the lifecycle of the app:

```swift

let sublimation = Sublimation(

  bindingConfiguration: .init(

    hosts: hosts, 

    configuration: configuration.hosting

  )

)

var app : Application

app.lifecycle.use(sublimation)

```

## Documentation

To learn more, check out the full [documentation](https://swiftpackageindex.com/brightdigit/SublimatioVapor/documentation).

# License 

This code is distributed under the MIT license. See the [LICENSE](https://github.com/brightdigit/SublimationVapor/LICENSE) file for more info.