https://github.com/brightdigit/sublimationservice

Using Sublimation as a Lifecycle Service for applications such as Hummingbird.
https://github.com/brightdigit/sublimationservice

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

Last synced: 4 months ago
JSON representation

Using Sublimation as a Lifecycle Service for applications such as Hummingbird.

• Host: GitHub
• URL: https://github.com/brightdigit/sublimationservice
• Owner: brightdigit
• License: mit
• Created: 2024-08-21T18:32:31.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-14T19:04:50.000Z (12 months ago)
• Last Synced: 2025-02-22T18:53:14.121Z (8 months ago)
• Topics: developer-tools, development-environment, hummingbird, server-side-swift
• Language: Shell
• Homepage:
• Size: 52.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    



SublimationService


Using [Sublimation](https://github.com/brightdigit/Sublimation) as a [Lifecycle Service](https://swiftpackageindex.com/swift-server/swift-service-lifecycle/2.6.1/documentation/servicelifecycle) for applications such as [Hummingbird](https://github.com/hummingbird-project/hummingbird).

[![](https://img.shields.io/badge/docc-read_documentation-blue)](https://swiftpackageindex.com/brightdigit/SublimationService/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/twitter-@brightdigit-blue.svg?style=flat)](http://twitter.com/brightdigit)

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

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

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

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

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

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

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

[![codebeat badge](https://codebeat.co/badges/88cc9ee4-5180-4ce5-93c6-a2e23dd532c3)](https://codebeat.co/projects/github-com-brightdigit-SublimationService-main)

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

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

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

# 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 **SublimationService** into your app using SPM, specify it in your Package.swift file:

```swift    

let package = Package(

  ...

  dependencies: [

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

  ],

  targets: [

      .target(

          name: "YourServerApp",

          dependencies: [

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

          ]),

      ...

  ]

)

```

# Usage

For instance if you are using this with [Hummingbird](https://github.com/hummingbird-project/hummingbird) and using [Bonjour](https://github.com/brightdigit/SublimationBonjour), you can just add it as a service:

```swift

let sublimation = Sublimation(

  bindingConfiguration: .init(

    hosts: hosts, 

    configuration: configuration.hosting

  )

)

var app = Application(

  router: router,

  server: .http1WebSocketUpgrade(webSocketRouter: wsRouter),

  configuration: .init(address: .init(setup: configuration.hosting))

)

app.addServices(sublimation)

```

## Documentation

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

# License 

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