Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/simonnickel/snap

An Overview of SNAP - SN App Packages
https://github.com/simonnickel/snap

swift swift-package-manager swift-ui swiftui

Last synced: about 1 month ago
JSON representation

An Overview of SNAP - SN App Packages

Awesome Lists containing this project

README 

        
# SNAP - SN App Packages



Welcome to SNAP, a set of packages I use to build iOS Apps. They contain shared code, generic implementations of common features, and a template to kickstart a new project.



Disclaimer: Most packages are focussed on my own needs. They are public for you to get inspired, learn and tell me what I am doing wrong (srsly, pls tell me!).



## Highlights



SNAP contains a few packages in varying sizes and complexities. Some depend on each other, while others are independent. In the end they are all pieces of the [snap-template](https://github.com/simonnickel/snap-template).



Another key package is [SnapTheme](https://github.com/simonnickel/snap-theme), which provides an abstraction layer to UI configuration and styling.



To explore SNAP, just check out the [example Apps](#apps) listed below or use it by copying the Demo project in [snap-template](https://github.com/simonnickel/snap-template).



## Guides



You need rules to break them, so I made up some of my own: [conventions](./conventions.md).



Packages are setup as described in [package-template.md](./package-template.md).



## Package Dependencies



```mermaid

flowchart TD



    subgraph Packages

    C1[foundation]

    C2[core]

    M2(theme)

    M3(settings-service)

    M4(navigation)

    M5(dependencies)

    M6(swift-data)

    M1(template)

    end

    

    A1{TemplateDemo}



    subgraph Apps

    A2{Theme Demo}

    A3{... App}

    end



    C1 --> C2

    C1 --> M4

    C1 --> M5



    C2 --> M2

    C2 --> M3



    M2 --> M1

    M3 --> M1

    M4 --> M1

    M5 --> M1



    M1 --> A1



    A1 -.->|Copy| Apps

    M6 --> Apps

```

Mermaid: [Docs](http://mermaid.js.org/intro/), [Editor](https://mermaid.live/)



## Packages



### snap-foundation

The [snap-foundation](https://github.com/simonnickel/snap-foundation) package contains basic general purpose extensions of Swift and Foundation.



### snap-core

The [snap-core](https://github.com/simonnickel/snap-core) package contains common extensions for Swift and SwiftUI types, useful helper implementations, convenience definitions and workarounds.



### snap-theme



The [snap-theme](https://github.com/simonnickel/snap-theme) package provides a toolset to abstract Colors, Fonts, Icons and Numbers of a multi-platform SwiftUI app. Define semantic attributes in a Theme and apply them to your views for a consistent UI with maintainability in mind.



A reference and demo app is available at: [snap-app-theme-demo](https://github.com/simonnickel/snap-app-theme-demo)



### snap-settings-service



The [snap-settings-service](https://github.com/simonnickel/snap-settings-service) is a simple wrapper to handle different types of settings. It stores a `Codable` type for a `String` key, either locally (UserDefaults), synced (NSUbiquitousKeyValueStore) or in a custom store.



### snap-navigation



The [snap-navigation](https://github.com/simonnickel/snap-navigation) package defines the apps screens and navigation structure. The SnapNavigationView displays and manages the screens in a TabView. 



### snap-swift-data



The [snap-swift-data](https://github.com/simonnickel/snap-swift-data) package extends SwiftData to better interoperate with CoreData and Persistent History Tracking.



### snap-template



The [snap-template](https://github.com/simonnickel/snap-template) package contains shared code and Demo Xcode project to setup and use SNAP in an App. The demo app comes with structure, navigation and infrastructure prepared, to quickly setup a new app using the SNAP packages.



## Apps



### snap-app-theme-demo

[snap-app-theme-demo](https://github.com/simonnickel/snap-app-theme-demo) is an example app project to showcase the SNAP suite. It uses the SnapAppTemplate and showcases features of the `SnapTheme` package. It contains a reference of attributes and defaults of the `Theme` and a catalog of adjustments to explore design changes.



## History



- The [snap-app-template](https://github.com/simonnickel/snap-app-template) was moved as Demo project into [snap-template](https://github.com/simonnickel/snap-template).

- [snap-matching-navigation](https://github.com/simonnickel/snap-matching-navigation) was replaced by [snap-navigation](https://github.com/simonnickel/snap-navigation).



## Package Collections



Not working at the moment! The Generator does not build, will try again in the future.



`packages.json` is prepared.



[Swift Package Collection](https://www.swift.org/blog/package-collections/)

[Generator](https://github.com/swiftlang/swift-package-collection-generator)