Sprig: Meal Planner in SwiftUI
Setup guide for Sprig, a complete Meal Planner Xcode project in SwiftUI. Install, rename and theme version 1.0.0.
Sprig is a complete Meal Planner in SwiftUI: an Xcode project you rename and ship. Sprig, a meal planning app: a complete Xcode project with recipes that fit your pantry, a week plan, a grocery list, nutrition stats, cook mode, widgets and three brand presets. This guide takes you from download to a running, renamed app. It covers version 1.0.0. See the screens on its library page.
Requirements
- Xcode 26 and an iOS 17.0 or later deployment target
- Tuist 4 (
brew install tuist) - An Apple Developer team for devices, App Groups and Sign in with Apple. The simulator runs without one.
Install
Download
Included with SwiftPieces Pro. Not signed in? The button takes you to sign in or create an account, then starts the download when you're back. Unzip the archive; it contains one folder, Sprig/.
Make it yours
cd Sprig
scripts/setup.sh --name YourApp --bundle-id com.you.yourapp --preset sprig-solThe script rewrites the project configuration, renames the paywall product ids, renders the app icon in the chosen preset and runs tuist generate.
Run it
Open YourApp.xcworkspace, choose an iPhone simulator and run the YourApp scheme. The first launch loads sample data so every screen has content.
Screens and flows
Sprig ships 18 screens, joined by 4 flows. Play each flow step by step on the site:
- First Run: onboarding, 11 steps. From the welcome through four questions, an account and Sprig Plus, to recipes ranked for your pantry.
- Cook Tonight's Dinner: core journey, 11 steps. Pick a need, open a collection and tonight's recipe, cook it step by step with timers, and see Progress count it.
- Plan The Week And Shop: core journey, 10 steps. Swap a dinner for one that uses what's about to turn, shop the list aisle by aisle and put it in the pantry.
- Profile And Settings: profile and settings, 10 steps. Change your diet and theme from the avatar, upgrade to Sprig Plus and start over.
Every screen is a SwiftUI view in the project. Search for its type to find the file.
| Screen | SwiftUI view | Where |
|---|---|---|
| Welcome | SprigOnboarding | First run |
| Diet | SprigOnboarding | First run |
| Allergies | SprigOnboarding | First run |
| Household | SprigOnboarding | First run |
| Weekly Goal | SprigOnboarding | First run |
| Sign In | SignInView | Account and subscription |
| Sprig Plus | PaywallView | Account and subscription |
| For You | ForYouScreen | Tabs |
| Plan | PlanScreen | Tabs |
| Pantry | PantryScreen | Tabs |
| Progress | ProgressScreen | Tabs |
| Collection | CollectionScreen | Details and sheets |
| Recipe | RecipeDetailScreen | Details and sheets |
| Cook Mode | CookModeView | Details and sheets |
| Grocery List | GroceryListScreen | Details and sheets |
| Profile | SprigSettingsScreen | Profile and settings |
| Change Diet | SettingsPickerList | Profile and settings |
| Theme | ThemeSettingsView | Profile and settings |
Rebrand options
| Option | What it sets |
|---|---|
--name | Target, scheme and product name. Letters and digits. |
--bundle-id | The bundle id. The widget, modules, tests and the App Group derive theirs from it. |
--display-name | The name under the icon. Copy that mentions the app reads it at runtime. |
--team | Your Apple Developer team id. |
--preset | The starting brand preset. Also re-renders the app icon. |
--product-prefix | App Store Connect product id prefix. Defaults to the bundle id plus .pro. |
The values live in Tuist/ProjectDescriptionHelpers/AppConfig.swift if you prefer to edit them by hand.
Theming
Sprig reads every color, type size, radius and animation from @Environment(\.spTheme). Its three presets are three different scheme families, so switching changes the whole look: ground, surfaces, color blocks, type and shape. People switch presets and appearance in Settings > Theme, and the widget follows.
| Preset | Id | Look | Type |
|---|---|---|---|
| Press | sprig-press | Newsprint bone, printing inks, hairline rules. | Inter |
| Sol | sprig-sol | Sun-bleached sand, marigold and terracotta. | Space Grotesk |
| Candy | sprig-candy | Cream, bright friendly blocks, rounded bold type. | DM Sans |
- Blocks:
theme.color.tilesholds each family's solid block colors with the ink that reads on them. Use them for categories, charts and highlights, and keep the accent for the primary action. - Numbers and display type:
theme.type.numeral(64)andtheme.type.display(40)set any size in the family's style, scaling with Dynamic Type. - Backdrop:
SPBrandBackdropdraws the family's motif (contours, scenery, shapes, blobs, rings, the Pearl haze, Confetti's sprinkles or Prism's luminous field) behind hero surfaces. - Liquid Glass:
.spGlassuses glass on iOS 26, Material on iOS 17 and 18, and an opaque surface under Reduce Transparency.
To build your own brand, start from the preset closest to it in BrandPresets.swift, copy it, and change its colors; every role and block pairing should keep 4.5:1 contrast. For a quick start from hues, SPBrandConfiguration.custom(...) builds an accessible palette from three OKLCH hues.
Purchases and accounts
PurchaseStorehandles StoreKit 2: products, purchase, restore and transaction updates. The scheme runs withConfiguration/Products.storekit, so purchases work in the simulator before App Store Connect is set up.- Create the products in App Store Connect with the ids in the project's catalog (the product prefix plus
.yearlyand.monthly). AccountStoresigns in with Apple and keeps the account in the Keychain. People can also continue without an account.- Data lives in SwiftData inside the App Group, so the widget reads the same store. Replace the sample data by conforming your own type to the repository protocol.
Launch arguments
Debug builds accept these arguments for demos and screenshots. Release builds ignore them.
| Argument | Effect |
|---|---|
-SPMockStore | Local purchases with the same plans |
-SPMockAccount | A signed-in sample account |
-SPSkipOnboarding | Open on the home screen |
-SPResetOnboarding | Run first launch again |
-SPResetData | Reseed the sample data |
-SPTab followed by a tab id | Open a tab |
-SPPresent paywall | Present the paywall |
-SPPreset sprig-sol | Start with a preset |
-SPAppearance dark | Force light or dark |
Changelog
1.0.0
2026-09-18
- Tuist project with feature modules (Onboarding, For You, Plan, Pantry, Progress, Settings) on a shared DesignSystem.
- One-command setup: name, bundle id, team, product ids, brand preset and app icon.
- Brand presets Press (default), Sol and Candy with Inter, Space Grotesk and DM Sans display type, switchable in Profile.
- First run with diet, allergies, household size and a weekly goal, then a StoreKit 2 paywall with a
.storekitconfiguration and a mock store for demos. - For You on the Recipes screen: drawn collection tiles that re-rank by need, counting only recipes that fit the diet and allergies; tonight's dinner and the best fits for the pantry.
- Recipe detail with servings scaling and pantry checks, and a full-screen cook mode with step timers that keeps the screen awake.
- Plan with a week strip, breakfast, lunch and dinner slots, a recipe picker and a grocery list merged, scaled and grouped by aisle, minus what the pantry has.
- Pantry with an input pill that guesses category and use-by date, use-soon blocks with a recipe for each, categories and check-offs.
- Progress on the Nutrition screen: food groups as packed bubbles, the plan cooked so far over a dot grid, daily capsule columns.
- SwiftData persistence in an App Group for the plan, pantry and grocery checks, with sample data and a repository protocol.
- Tonight (medium, with a mark-cooked button) and Groceries (small) widgets.
- Light and dark mode, Dynamic Type through the accessibility sizes, VoiceOver labels and actions, Reduce Motion.
- String catalog, unit tests and a first-run UI test.