WrapFast Documentation

Get Started

In-App Purchases

Firebase

WishKit

AI Backend

Xcode Project

API Client

Support

The WrapFast iOS app boilerplate features examples of implementation using SwiftUI of:

• a calorie counter using the Vision API
• a chatbot using the ChatGPT API
• an image generator using the DALL·E API.

Each one is in its proper tab within a Tab Bar.

WrapFast also includes another Tab for a Settings view.

Replacing Keys and Constants

All the keys, links and constant values in the project are retrieved from the Constants.swift file. You need to replace here:

• Purchases:
  • key Your RevenueCat API Key
  • premiumEntitlementIdentifier the id of your RevenueCat Entitlement(premium by default)
  • termsOfServiceLink The URL of your Terms of Service.
  • privacyPolicyLink The URL of your Privacy Policy.
• WishKit.key Your WishKit project key if you want to use it.
• Api
  • baseURL The URL to your backend. It must end with a Slash /
  • authKey The key to request the secret token to the backend to /auth endpoint
  • appIdentifier the identifier of your app to handle it in the backend
• AIProxy
  • partialKey If you are using AIProxy services for the AI Api requests, paste your key here.
• DeveloperInfo
  • name The name you want to appear in the credits section
  • contactEmail The email to contact support
  • twitterUrl The Twitter/X URL to your profile for the credits section
• freeCredits The number of free credits if you want to use a freemium monetization model
• appStoreAppId The id of your app in the App Store. You can check it in App Store Connect
• faqMarkdown The FAQ text in Markdown. It will be used within a Text View in the FAQView, in Settings.

Project Structure

The project is built using the MVVM pattern. Each functionality is separated in a group to keep it neatly organized

The boilerplate includes all the structure and foundation that allows you to create monetizable products rapidly:

• Onboarding flow
• In-App Purchases
• Paywall
• What’s new view
• Request App Reviews
• A complete authentication and account deletion flow
• Implementation examples of OpenAI products
• A native API Client
• A Settings view featuring
  • Premium User status
  • Language
  • Dark Mode
  • Features Requests
  • FAQ
  • Support Request
  • User Profile Information
• Reusable UI Components
• Firebase integration
• A Logger
• Several Utilities and useful Extensions
• Custom Fonts
• Custom Colors
• Localization
• Animations using Lottie

Onboarding

WrapFast includes two types of Onboarding Views:

• Single Page: Add as many features as you need using the component

OnboardingFeature(image: Image(systemName: "imageName"),
                                      imageColor: .blue,
                                      title: "Your title",
                                      description: "Your description")

• Multiple Pages: Add as many pages as you want to the array pages

MultiplePagesOnboardingFeatureModel(imageName: "imageName", title: "Your title", description: "Your description")

After the Onboarding, it navigates to the Request Review View.

If you want, skip the request review and navigate directly to LoginView or any other view.

Even that requesting the review without trying the app could feel dumb, evidences have demonstrated that this converts a lot.

Other strategy is requesting review after a success moment. For example in a to-do list app, after completing one ore several tasks. In an AirBnB like app, after booking an apartment successfully and so on.

<aside> 💡 It's important to know that you only have 3 ATTEMPTS PER YEAR to request a review, so place them wisely.

</aside>

<aside> 💡 I also added recently this animated onboarding crAionOnboarding.swift that I made for one of my apps. If it fits your use case, feel free to use it and tweak regarding your needs 😃

</aside>

crAion’s Onboarding

crAion’s Onboarding

PaywallView

Showing the Paywall during the onboarding is highly recommended, as it is the comment where users are more willing to pay.

To build the paywall we use RevenueCat as we say in In-App Purchases

Add as many Paywall features as you want with the component:

PaywallFeature(title: "Feature title", description: "Feature description.")

What’s new view

This view is intended to showcase to the user new features or changes between versions.

It compares the current version with the latest one saved, so if it is different or nil, it triggers the sheet showing the view.

In the boilerplate it is triggered from the Vision View, but you can place it wherever you need:

If it is the first version, or you don’t have anything you show across versions, just comment or remove the line calling the function.

Authentication

This View handle the authentication flow. It injects the AuthManager to handle the Sign in with Apple logic and the UserManager to handle the user creation and state.

Sign in flow:

1. We do Sign in with Apple with Firebase Authentication and we store the Firebase Authentication User.
2. We try to fetch the user data (User.swift) from Firestore. (User data can be whatever you need, it is up to you).
3. If the user does not exist in Firestore (first login for example), we create a new one.
4. We store free credits in Keychain (optional) and set that user has completed the onboarding flow to true—to not show again the onboarding to the users next time they enter the app.
5. Set app authentication state to true. This triggers showing our main app views.

Managers

WrapFast boilerplate implements several managers and services to interact with different logic along the app. Each aspect of the application's functionality is encapsulated, promoting modularity, reusability, and separation of concerns, which are key principles of software design.

Here's a general definition of the roles each manager play:

• AuthManager: Handles all authentication-related processes. This include signing in, signing out, delete user.
• FirestoreService: Manages interactions with Firestore. It abstracts database queries, document reads/writes. In the boilerplate implements examples of how to make CRUD operations for the User information.
• UserManager: Handles the state of user’s profile information, authentication state and subscription state. Injects the DatabaseServiceProtocol to retrieve the user information from Firestore and the PurchasesManager to handle the subscription state.
• PurchasesManager: Handles in-app purchases, subscription management and operations related to RevenueCat. It provides properties and functions to build a custom paywall manually or manually purchase products.
• AuthBackendService: Service to request the secret token to the AI Backend
• AnalyzeMealVisionService: Service to request a meal analysis to the /vision endpoint. You can use Anthropic changing the Endpoint requested for Endpoints.anthropicMessages
• ChatGPTService: Service to send a prompt to ChatGPT or Anthropic Messages and request a text response. You can use Anthropic changing the Endpoint requested for Endpoints.anthropicMessages

• DALLEService: Service to send a prompt to DALL·E and request an image response.
• KeychainManager: Manages secure storage and retrieval of sensitive information like passwords and tokens using iOS's Keychain services. It implements convenient functions to store free credits to implement a freemium model.