Skip to content

Latest commit

 

History

History
193 lines (166 loc) · 9.6 KB

README.md

File metadata and controls

193 lines (166 loc) · 9.6 KB

FlineDevKit Logo

FlineDevKit

FlineDevKit is a framework that simplifies the development process by automatically importing the most common frameworks I recommond for every app. The core of the library is FlineDevKit.swift, which contains a collection of @_exported import statements. This eliminates the need to manually import these frameworks in every Swift file of your app.

Auto-Imported Frameworks

Apple Frameworks

FlineDevKit automatically imports essential Apple frameworks for iOS, macOS, and SwiftUI apps:

  • Foundation: Core APIs for data, networking, and files.
  • OrderedCollections: Flexible, ordered data structures.
  • OSLog: Efficient app logging with custom levels.
  • SwiftData: Simplified data management with models.
  • SwiftUI: Declarative UI framework for Apple platforms.
  • TipKit: Tools for tips and onboarding experiences.

FlineDev Frameworks

FlineDevKit includes my own frameworks for modern Swift development:

3rd-Party Frameworks

FlineDevKit also includes these recommended libraries:

Usage

To use FlineDevKit, simply add it to your project as a Swift package:

  1. Add the following URL as a Swift package dependency in Xcode:
    https://github.com/FlineDev/FlineDevKit.git
  2. Reference the main branch, and let Xcode automatically load all the recommended dependencies.

Package Mapping in Xcode

After adding the package, you can import FlineDevKit in your app's Swift files. You’ll no longer need to import individual frameworks like Foundation, SwiftUI, SwiftData, OSLog, and others. This works similarly to how Apple automatically adds import SwiftUI or import Foundation by default in new SwiftUI files.

For example, when you create a new SwiftUI view, SwiftUI itself imports several underlying libraries, such as Foundation, CoreGraphics, and others, which are necessary for the view to work properly. Similarly, when you import FlineDevKit, it will include all the necessary dependencies behind the scenes, so you don’t need to worry about importing each one individually. This makes your code cleaner and reduces the need to manage numerous imports, making it easier to maintain and scale your app.

By using FlineDevKit, you’ll also automatically have access to my personal libraries such as ReviewKit, LinksKit, HandySwift, HandySwiftUI, and FreemiumKit, which I highly recommend for common app features.

Feel free to use this package as-is or fork it and adjust it to your own needs! But note that you don't need to fork it if you want to use most of my libraries except maybe for one or two. There are no side effects if you simply ignore them, each library is quite small in its own regard and none of them do automatic work in the background unless you explicitly use them.

I will add a few more libraries I am currently working on, such as ErrorKit for improved error handling. But those will also be well designed, extensively documented, small in footprint and generally useful for every app, or else I wouldn't add them here. Promise!

License

This library itself is released under the MIT License. See LICENSE for details.

For the licenses of the imported libraries, see their own LICENSE files.

Showcase

I created this library for my following Indie apps (rate them with 5 stars to support me!):

App Icon App Name & Description Supported Platforms
TranslateKit: App Localizer
Simple drag & drop translation of String Catalog files with support for multiple translation services & smart correctness checks.
Mac
Pleydia Organizer: Movie & Series Renamer
Simple, fast, and smart media management for your Movie, TV Show and Anime collection.
Mac
FreemiumKit: In-App Purchases
Simple In-App Purchases and Subscriptions for Apple Platforms: Automation, Paywalls, A/B Testing, Live Notifications, PPP, and more.
iPhone, iPad, Mac, Vision
FreelanceKit: Time Tracking
Simple & affordable time tracking with a native experience for all  devices. iCloud sync & CSV export included.
iPhone, iPad, Mac, Vision
CrossCraft: Custom Crosswords
Create themed & personalized crosswords. Solve them yourself or share them to challenge others.
iPhone, iPad, Mac, Vision
FocusBeats: Pomodoro + Music
Deep Focus with proven Pomodoro method & select Apple Music playlists & themes. Automatically pauses music during breaks.
iPhone, iPad, Mac, Vision
Guided Guest Mode
Showcase Apple Vision Pro effortlessly to friends & family. Customizable, easy-to-use guides for everyone!
Vision
Posters: Discover Movies at Home
Auto-updating & interactive posters for your home with trailers, showtimes, and links to streaming services.
Vision