WikipediaBrown / napkin

napkin is a reimagining of Uber's RIBs with RXSwift replaced by Combine and the Leak Detector removed (you should use Xcode Instruments instead).

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

napkin

Now Supporting SwiftUI

Release Workflow Swift Versions Platforms Supported

napkin is a reimagining of Uber's RIBs with RXSwift replaced by Combine and the Leak Detector removed (you should use Xcode Instruments instead).

πŸ› οΈ Installation

napkin can be installed with Swift Package Manager.

Swift Package Manager (Xcode 12 or higher)

The preferred way of installing napkin is via the Swift Package Manager.

  1. In Xcode, open your project and navigate to File β†’ Swift Packages β†’ Add Package Dependency...
  2. Paste the repository URL (https://github.com/WikipediaBrown/napkin.git) and click Next.
  3. For Rules, select Version (Up to Next Major) and click Next.
  4. Click Finish.

Adding Package Dependencies to Your App

πŸ‘©πŸ½β€πŸ’» Usage

Coming Soon!

πŸͺ› Tooling

πŸ—ΊοΈ Get napkin Xcode templates

napkin comes with sweet templates that let you add all of the components of a napkin (Builder, Interactor, Router & optional ViewController) straight from the New > File.. menu. To add them:

Clone the repository

git clone https://github.com/WikipediaBrown/napkin.git

Install Xcode Templates

bash napkin/Tools/InstallXcodeTemplates.sh

Check Xcode

Open an Xcode project and create a new napkin. Let us know if it doesn't work by creating an issue

πŸ§ͺ Test

Run command+u in Xcode to run the unit tests. Test are run automatically for all pull requests. When running tests locally, be sure to be using iOS 17.2 or later or macOS 14.5 or later.

🏎️ Fastlane Scan

You can also run tests on both iOS & macOS using fastlane. This requires installing fastlane which in turn requires installing Homebrew. With Homebrew and fastlane installed you can open a terminal and navigate to the SFSymbolsKit's root folder and run the command fastlane unit_test. This will run the unit tests for both iOS & macOS in succession.

🐁 Versioning

napkin releases a new version on GitHub automatically when a pull request is approved from the develop branch to the main branch.

πŸ‘©πŸ½β€πŸ’» Contribute

Send a pull request my dude... or create an issue.

Must sign commits: run git config commit.gpgsign true

from this repository

✍🏽 Author

Wikipedia Brown

πŸͺͺ License

napkin is available under the Apache 2.0 license. See the LICENSE file for more info.

Made with 🌲🌲🌲 in Cascadia

About

napkin is a reimagining of Uber's RIBs with RXSwift replaced by Combine and the Leak Detector removed (you should use Xcode Instruments instead).

License:Apache License 2.0


Languages

Language:Swift 89.2%Language:Ruby 8.6%Language:Shell 2.3%