https://github.com/vaporexampleslab/synergy
Various pieces of how to setup a Vapor server, iOS device client and a macOS client to use the same Swift Packages.
https://github.com/vaporexampleslab/synergy
swift-package-manager vapor vapor-example
Last synced: 3 months ago
JSON representation
Various pieces of how to setup a Vapor server, iOS device client and a macOS client to use the same Swift Packages.
- Host: GitHub
- URL: https://github.com/vaporexampleslab/synergy
- Owner: VaporExamplesLab
- Created: 2019-03-26T22:34:26.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-05-19T17:37:24.000Z (about 7 years ago)
- Last Synced: 2024-12-31T21:26:12.794Z (over 1 year ago)
- Topics: swift-package-manager, vapor, vapor-example
- Language: Swift
- Homepage:
- Size: 274 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Synergy: Vapor Server + Device Apps
[SynergySqliteC](#linkSynergySqliteC) •
[SynergySQLiteFramework](#linkSynergySQLiteFramework) •
[SynergyAPI](#linkSynergyAPI) •
[SynergyVapor](#linkSynergyVapor) •
[Synergy Clients](#linkSynergyClients) •
[Resources](#Resources)
I've been using Swift Packages for both iOS/macOS clients and Vapor backend development for some time. I'm in the process of gathering the lessons learned into a generic set of Open Source repositories: [VaporExampleLabs/Synergy*](https://github.com/VaporExamplesLab/Synergy).
It is possible to have Swift Packages which can be used on the Swift server side, and on iOS devices and in macOS applications. A greater separation between the views (Vapor `View`, iOS `UIView`, macOS `NSView`) and underlaying application logic, allows more code to be shared in Swift Packages across the platforms.
The [VaporExampleLabs/Synergy*](https://github.com/VaporExamplesLab/Synergy) collection of packages & projects provides various working pieces of how to setup a Vapor server, iOS device client and a macOS client to use the same Swift Packages.
Each part highlights some key findings for the use of a Swift code shared in both Server backend and Client device software development.
_Note: The Synergy set of projects and packages are still a **work in progress** for gathering lessons learned. The goal is to create a full (self-contained) set of backend-to-client connected examples sharing common Swift Packages._
Sometimes lower level libraries are not common between the server and device. For example, the database Object Relationship Model (ORM) is different for Vapor and iOS/macOS have CoreData. Vapor provides Fluent. iOS/macOS provides CoreData.
This example illustrates direct use the SQLite C source code at the lowest level.
[SynergySqliteC ⇗](https://github.com/VaporExamplesLab/SynergySQLiteC) shows how to setup a cross platform C library into a Swift Package.
## SynergySQLiteFramework [▴](#toc)
[SynergySQLiteFramework ⇗](https://github.com/VaporExamplesLab/SynergySQLiteFramework) provides a _generic_ Swift framework for using the C-base Swift Package `SynergySqliteC`.
[SynergyAPI ⇗](https://github.com/VaporExamplesLab/SynergyAPI) provides the Codable interface for the collection of Synergy applications. Uses the generics SQLite package `SynergySQLiteFramework`.
[SynergyVapor ⇗](https://github.com/VaporExamplesLab/SynergyVapor) provides an example Vapor web application which uses the `SynergyAPI`.
[Synergy ⇗](https://github.com/VaporExamplesLab/Synergy) provides both an iOS and macOS client Xcode projects. Both the iOS and macOS clients use the `SynergyAPI` package.
**Swift Packages in iOS/macOS Applications**
> Note that at this time the Package Manager has no support for iOS, watchOS, or tvOS platforms. [Source: Swift Package Manager Project](https://github.com/apple/swift-package-manager)
Even though the Swift Package manager _can not directly_ create an iOS or macOS application, Swift Packages can still be used as subprojects in the respective Xcode application projects.
``` bash
cd SynergyAPI
swift package generate-xcodeproj \
--xcconfig-overrides Package.iOS.xcconfig \
--output SynergyAPI_iOS
swift package generate-xcodeproj \
--xcconfig-overrides Package.macOS.xcconfig \
--output SynergyAPI_macOS
```
* [StackOverflow: How do I use Swift Package Manager with an existing macOS project? ⇗](https://stackoverflow.com/questions/48837369/how-do-i-use-swift-package-manager-with-an-existing-macos-project)
* [StackOverflow: Vapor server and companion iOS app examples ⇗](https://stackoverflow.com/questions/47717355/vapor-server-and-companion-ios-app-examples/48373393#comment97266087_48373393)