Documentation

Introduction

Please carefully read this guide in order to fully configure this template, and rememeber to test it on a Real Device - the iOS Simulator may fail sometimes and it doesn't support Push Notifications nor Camera.

Quick Start

You may just run this app on your own device via Xcode and play with it, it will work.
Anyway you need to perform some configurations in order to be able to publish your own version of this app on the App Store, so just keep reading this guide.

General

Xcode
This template has native Apple Swift code, so you can edit it only with Xcode running on a Mac computer. If you don't have it, download it for free on the Mac App Store.
PLEASE NOTE that you'll need the latest official version of Xcode, NO BETAS, because Betas are always buggy and never work properly.


App Name and Bundle ID
You must change the Display Name and Bundle Identifier into the new ones in the General tab in Xcode:


Archive App for App Store Publishing
Once your app is ready to be submitted to the App Store for review, you need to Archive your Xcode project.
Click on Product and select Archive. Xcode will archive your project and automatically open the Organizer window, where you'll find a button to submit your binary to your App Store Connect account.
Reskin the UI design of the app
This project has a Storyboard file called Main.storyboard and you can find it in the list of file that are shown in left-side panel of the Xcode window.
You can edit all the UI elements of this app from the Storyboard, Colors, Fonts, Buttons, Views positions, etc.
The strings of the Alert Controllers are located in the code, so they can be edited only in the .swift files.


Configurations

The Configurations.swift file
Open this file in Xcode and keep reading this guide, you'll have to perform some edits in this file in order to get your template ready to run:

App Name
Replace this string with the new name you want to give to this app:
    let APP_NAME = "ShotQuotes"

AdMob Ads
Replace the string of the variable below with your own Interstitial Unit ID - you have to create such Unit ID on apps.admob.com, just follow the instructions on the AdMob's website in case you don't know how to generate a Unit ID:
 let ADMOB_INTERSTITIAL_UNIT_ID = "ca-app-pub-3940256099942544/1033173712"

You also have to replace the string into Info.plist with your own App ID:

You can get both App ID and Unit ID strings from your AdMob Unit page, after creating it:
Sometimes Apple reviewers reject apps because of Ads, the reason why is not clear yet, but a new submission on the App Store will fix the problem and get your app approved - just in case you'll get a rejection because of IDFA issue.
Anyway, after clicking the Submit For Review button on the App Store Connect page of your application, you’ll get something that looks like the picture below. Mark the options shown below and everything should go smoothly on the next review you'll get of your app:

Custom Colors
You can edit the HEX value of the following variable as you wish, so the main color of the app and some UI will be affected by your change:
  let MAIN_COLOR = hexValue(hex: "#23A0F1")

PLEASE NOTE that NOT all Views in the app will change accordingly to the new HEX value you've set in the above variable, you will still need to adjust some colors in some Controllers in the Storyboard.

Custom fonts
This App uses some custom fonts, and such fonts are stored into the Poppins folder.
In case you want to add a new font, you have to first drag your .ttf or .otf font file into the left-side panel in Xcode and click the Finish button in the popup that will show up: Then select the Label, Button, TextFiled or textView you want to change font to, click the [T] icon on the right-side Attributes inspector panel and select the font you want in the dropdown list:

Sharing message
When you're about to share a picture, the app shows a custom message, you can edit it as you wish by changing the string of the below variable:
   let SHARING_MESSAGE = "Hey, check out my awesome quote, I've made it with #\(APP_NAME) "


Array of Photo Filters
This app uses a few CoreImage standard filters for photos, which are listed in the following array:
   var filtersArray = [
    "None",
    "CIPhotoEffectInstant",
    "CIPhotoEffectProcess",
    "CIPhotoEffectTransfer",
    "CISepiaTone",
    "CIPhotoEffectFade",
    "CIPhotoEffectTonal",
    "CIPhotoEffectNoir",
    "CIDotScreen",
    "CIColorMonochrome"
]


Free and Total amount of overlays
The following 2 variables store the anount of FREE and TOTAL amount of overlay images (stored into the OVERLAYS folder):
    let FREE_OVERLAYS = 15
    let ALL_OVERLAYS = 84
You can edit those numbers as you wish, just note that the ALL_OVERLAYS number must always equal the total amount of PNG images you've stored in the OVERLAYS folder, since you're free to drag new PNG images into that folder in Xcode.


Utility Functions
Unless you are familiar with iOS programming, you should leave the code of this section as it is since it includes useful functions to show alerts and perform other things in the app.


In-App Purchase

Prepare your app for IAP
In order to get In-App Purchase ready for your app, you need to create your app's page on the App Store Connect website: https://appstoreconnect.apple.com/

You also must have an Active Paid Apps Agreement in the Agreemets, Tax, and Banking section, otherwise you won't be able to create or benefit of IAP:

After you've created your app's page in the My Apps section and set your App Information, enter the Features -> In-App Purchases section, click the + button and select the Non-Consumable option, then click the Create button:
Fill the fields with the reference name of your IAP product and its ID (comething like com.appnamne.productid), select its Price, Display Name, Description and the Review Information, then click the Save button. Check this screenshot as an example:
Enter the Prepare for Submission section, scroll down to where In-App Purchases title is and click the + button. Select the IAP product you've just created and click the Done button.

Now you can enter Xcode, the Configurations.swift file, and replace the string of the following variable with the IAP Product ID you've previously set on the App Store Connect page:
 let IAP_PRODUCT_ID = "com.shoutquotes.unlockoverlays"
You're done with setting up In-App Purchase now, so you can run your app and test it out with your Sandbox account. You should be already logged in with your Sandbox account in the Settings -> iTunes & App Stores section of your device -> SANDBOX ACCOUNT:

Useful stuff

F.A.Q.

Should I use Xcode to edit this template?
Yes, you must always use the latest stable officlal version of Xcode to edit this application.
Download the latest version on the Mac App Store from your Mac.

What kind of support is offered?
Free support is offered in case of bugs encountered in the original template, either in the code or the UI design.
In case you have edited the code - and so created bugs because of your editing - I may apply some fee to fix your bugs by a remote connection through TeamViewer, or by you sending me your source code for verification.

Support | Requests