https://github.com/cypherpoet/swiftuistarterkit

A collection of some personal utilities that I use for building SwiftUI applications.
https://github.com/cypherpoet/swiftuistarterkit

swift swift-packages swift-world-domination swiftui swiftui-masterrace swiftui-utilities swiftui-world-domination

Last synced: 4 days ago
JSON representation

A collection of some personal utilities that I use for building SwiftUI applications.

• Host: GitHub
• URL: https://github.com/cypherpoet/swiftuistarterkit
• Owner: CypherPoet
• License: mit
• Created: 2019-10-15T20:45:34.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2022-03-06T11:22:15.000Z (over 2 years ago)
• Last Synced: 2023-03-02T17:41:32.422Z (over 1 year ago)
• Topics: swift, swift-packages, swift-world-domination, swiftui, swiftui-masterrace, swiftui-utilities, swiftui-world-domination
• Language: Swift
• Homepage: https://cypherpoet.github.io/SwiftUIStarterKit/
• Size: 122 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# SwiftUI Starter Kit



    

    

    

    

    

    

    

    

    

      

    

    

        

    



_A collection of miscellaneous — super-basic — utilities that I use for building SwiftUI applications._

# Installation

### Xcode Projects

Select `File` -> `Swift Packages` -> `Add Package Dependency` and enter `https://github.com/CypherPoet/SwiftUIStarterKit`.

### Swift Package Manager Projects

You can add this project as a package dependency in your `Package.swift` file:

```swift

let package = Package(

    //...

    dependencies: [

        .package(

            url: "https://github.com/CypherPoet/SwiftUIStarterKit",

            .exact("0.0.59")

        ),

    ],

    //...

)

```

From there, refer to the `SwiftUIStarterKit` "product" delivered by the `CypherPoetSwiftUIStarterKit` "package" inside of any of your project's target dependencies:

```swift

targets: [

    .target(

        name: "YourLibrary",

        dependencies: [

            .product(name: "SwiftUIStarterKit", package: "CypherPoetSwiftUIStarterKit"),

        ],

        ...

    ),

    ...

]

```

Then simply `import SwiftUIStarterKit` wherever you’d like to use it.

## ⚠️ Disclaimer

Currently, this project is mainly for personal use, and, as the commit history shows, is subject to fast and loose changes.

Nonetheless, several people have asked me to open-source it so they can use it as inspiration or as a starting point for their own utilities. That would be my recommended approach — though if you really want to be edgy and attempt direct usage, please at least pin it to an exact release tag, as shown in the installation instructions above.

## 💻 Developing

### Requirements

- Xcode 13.0+ (Recommended)

### 📜 Creating & Building Documentation

Documentation is built with [Xcode's DocC](https://developer.apple.com/documentation/docc). See [Apple's guidance on how to build, run, and create DocC content](https://developer.apple.com/documentation/docc/api-reference-syntax).

For now, the best way to view the docs is to open the project in Xcode and run the `Build Documentation` command. At some point in the future, I'm hoping to leverage the tooling the develops for generating/hosting DocC documentation. (Please feel free to let me know if you have any ideas or tooling recommendations around this 🙂).

## 🏷 License

`SwiftUIStarterKit` is available under the MIT license. See the [LICENSE file](./LICENSE) for more info.