napkin is a reimagining of Uber's RIBs with RXSwift replaced by Combine and the Leak Detector removed (you should use Xcode Instruments instead).
napkin can be installed with Swift Package Manager.
The preferred way of installing napkin is via the Swift Package Manager.
- In Xcode, open your project and navigate to File → Swift Packages → Add Package Dependency...
- Paste the repository URL (
https://github.com/WikipediaBrown/napkin.git) and click Next. - For Rules, select Version (Up to Next Major) and click Next.
- Click Finish.
Adding Package Dependencies to Your App
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:
git clone https://github.com/WikipediaBrown/napkin.git
bash napkin/Tools/InstallXcodeTemplates.sh
Open an Xcode project and create a new napkin. Let us know if it doesn't work by creating an issue
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.
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.
napkin releases a new version on GitHub automatically when a pull request is approved from the develop branch to the main branch.
Send a pull request my dude... or create an issue.
Must sign commits:
run
git config commit.gpgsign true
from this repository
Wikipedia Brown
napkin is available under the Apache 2.0 license. See the LICENSE file for more info.
Made with 🌲🌲🌲 in Cascadia