Skip to content

Latest commit

 

History

History
210 lines (152 loc) · 13.6 KB

README.md

File metadata and controls

210 lines (152 loc) · 13.6 KB
Raw

MPDX Client App

Instrucitons for building this app, taken from Cru's mpdx-ios-client-example-app Includes Swift Package Manager and Cocoapods example projects to facilitate in the creation of your templated MPDX iOS App.

Requirements

  • Xcode Version: 14.2
  • Minimum iOS Target: iOS 14
  • Dependency Manager: Swift Package Manager or Cocoapods
  • MPDXiOSLib: View version here or here.

Steps To Create Templated MPDX iOS App

Follow these outlined steps to get your Xcode project setup and running against the MPDXiOSLib code-base.

Create A New Xcode Project

Start by creating a new Xcode project. Make sure to choose the following when creating your new Xcode project.

  • For the project template choose App.
  • Ensure Use Core Data is not checked.
  • If you wish to include your own tests then check include Tests otherwise you can leave this unchecked.

Install The MPDXiOSLib Dependency

Choose 1 of the next 2 steps to install the MPDXiOSLib dependency.

NOTE: You can view the latest MPDXiOSLib version either here or here.

Install MPDXiOSLib With Swift Package Manager

  • Swift Package Manager Documentation is here.
  • Locate your Xcode project package dependencies and tap the add icon to add the MPDXiOSLib git repo. alt text

  • Enter the repo https://github.com/CruGlobal/mpdx-ios-lib.git in the search field.
  • Set Dependency Rule to Up to Next Minor Version.
  • Set the minimum version. You can view the latest MPDXiOSLib version here or here.
  • Add the Package. alt text

  • Xcode will finish loading, then add package to target. alt text

Install MPDXiOSLib With Cocoapods

  • First install the cocoapods dependency manager.
  • Add a Podfile to your project directory. You can review the MPDXClientExampleCocoapods Podfile for reference on setting that up here. NOTE that your target name or names(if including tests) will be different than the MPDXClientExampleCocoapods target name. The main target name will match the Xcode project name.
  • Also note the version might be later than the linked example. Find the latest available version here or here.
  • Open the Terminal app to your Xcode project directory and run command pod install. Once completed you will have a .xcworkspace file which you can now open to configure in the next step.

Configure Your New Xcode Project

  • Now it's time to finish configuring your Xcode project.
  • The Xcode file to open will depend on the dependency manager used.
    • For Swift Package Manager open the .xcodeproj file.
    • For Cocoapods open the .xcworkspace file (generated from pod install).
  • Configure your Xcode project build target.
    • Delete Mac under Supported Destinations. Should be iPhone and iPad.
    • Set Minimum Deployments to iOS 14.0.
    • Set iPhone Orientation to Portrait.
    • Set iPad Orientation to Portrait, Landscape Left, Landscape Right.
    • Set Status Bar Style to Default.
    • Check Requires full screen. alt text

  • Configure your Xcode project info.
    • Set the iOS Deployment Target to iOS 14. alt text

  • Delete the .swift files that Xcode generated for SwiftUI projects.
    • Select the ContentView.swift and "YourProjectName"App.swift file and hit the delete key.
    • Choose the Move to Trash option. alt text

  • Add Application Scene Manifest to Xcode build target info.
    • In your Xcode target > Info section, locate the Custom macOS Application Target Properties section.
    • Tap the plus icon on the bottom row option which will bring up a new row and start typing Application Scene Manifest. Xcode should auto find this and tap enter when it does. You should now see the added Application Scene Manifest and that's it. alt text

  • Add AppDelegate.swift.
    • Right click on project folder and add new file. alt text

    • Choose Swift File template. alt text

    • Input AppDelegate for name and choose Create. Don't create bridging header. alt text

    • If Xcode requests to configure an Objective-C bridging header choose Don't Create. alt text

    • Complete the AppDelegate.swift implementation. An example is here. alt text

    • AppDelegate.swift will need to provide an instance conforming to AppConfigInterface.swift in method override func getAppConfig(). See the next step for setting this up.
  • Add AppConfig.swift. Follow the same instructions you used for adding the AppDelegate.swift file and add AppConfig.swift.
    • For an AppConfig.swift reference you can view that here.
    • Set your apiBaseUrl: String.
    • Set your authenticationConfiguration: AuthenticationConfiguration.
  • IMPORTANT: Add usage descriptions. These are descriptions apple looks for when a user attempts to access their device contacts or device face id from the MPDX app. Without these the app will crash. Since these files can't be bundled with MPDXiOSLib, they must be manually added to your Xcode project.
    • To manually add them first download the latest MPDXiOSLib zip here.
    • In finder look in the downloaded directory for /Sources/MPDXiOSLib/Resources/UsageDescriptions/ and copy the UsageDescriptions directory into your project directory where Assets.xcassets, Info.plist, and .entitlements live. Make sure you're in finder and not the Xcode project. alt text

    • Back in Xcode right click your project directory and choose Add Files and choose the Usage Descriptions directory you just added. Ensure Create groups is checked. alt text

      alt text

    • You should now see the Usage Descriptions InfoPlist files in your Xcode project. alt text

    • That's it. You should now be able to build and run Xcode.

App Localization

Localizable.strings files are bundled in MPDXiOSLib and by default your templated MPDX App will support the following languages found here.

Configuring AppConfig

The AppConfigInterface.swift exists to configure anything specific to your app. When creating the AppDelegate.swift you will override MPDXAppDelegate getAppConfig() to return your own instance with configuration settings. AppConfigInterface.swift contains the following configuration attributes.

- apiBaseUrl: String

This is the base url that points to your API. For example MPDX Staging uses https://api.stage.mpdx.org

- authenticationConfiguration: AuthenticationConfiguration
- coreDatabaseConfiguration: CoreDatabaseConfiguration
- deepLinkingConfiguration: DeepLinkingConfiguration?

This is optional and you can return a DeepLinkingConfiguration value to enable deeplinking into your app.

- firebaseConfiguration: FirebaseConfiguration?

This is optional and you can return a FirebaseConfiguration value to enable firebase analytics. Here you will provide the name of the GoogleService file .plist created in Firebase and added to your Xcode project. For example in MPDX we use GoogleService-Info for the firebaseGoogleServiceFileName.

- googleAnalyticsConfiguration: GoogleAnalyticsConfiguration?

This is optional and you can return a GoogleAnalyticsConfiguration value to enable google analytics. Here you will provide your google analtyics identifier. The dispatch interval is optional and can be lowered for debugging purposes.

- impersonateConfiguration: MPDXApiImpersonateConfiguration?

For this setting return nil. We've been experimenting with a way to impersonate users for debugging purposes only and this isn't something that is available.

Distribution

For automated build distributions we use a GitHub Actions workflow with a combination of Fastlane and GitHub Actions secrets.

Add Gemfile

The client example contains a Gemfile in the project directory. Add this same Gemfile to your project directory. The GitHub Actions workflow will utilize this Gemfile for installing any dependencies such as Fastlane.

Add Fastlane

This next step will involve adding Fastlane to your project.

In your project directory create a folder named fastlane and add the following files.

  • Fastfile
  • Matchfile
  • .gitignore
  • .env.default
Fastfile

For the Fastfile copy the same contents as in the client example (https://github.com/CruGlobal/mpdx-ios-client-example-app/blob/main/fastlane/Fastfile).

Matchfile

For the Matchfile copy the contents from the client example (https://github.com/CruGlobal/mpdx-ios-client-example-app/blob/main/fastlane/Matchfile).

IMPORTANT: The git URL will need to be your own private repository git url for code signing. See the section below for Fastlane Match.

.gitignore

For the .gitignore copy the same contents as in the client example (https://github.com/CruGlobal/mpdx-ios-client-example-app/blob/main/fastlane/.gitignore).

Fastlane creates an AppleAppStoreApi.json file which is used for the App Store Connect API so this file needs to be ignored.

.env.default

For the .env.default copy the same contents as in the client example (https://github.com/CruGlobal/mpdx-ios-client-example-app/blob/main/fastlane/.env.default). You will need to update some values that are specific to your app.

APP_RELEASE_BUNDLE_IDENTIFIER - this value will be your app store app bundle id. APP_STORE_CONNECT_API_KEY_JSON_FILE_PATH = this value must match the mpdx client example.

Code Signing

CODE_SIGNING_APP_BUNDLE_IDS - this value will be your app store app bundle id. CODE_SIGNING_PROVISIONING_PROFILE_NAMES - this value would replace org.cru.mpdxclientexample with your app store app bundle id. CODE_SIGNING_TARGETS - this value is the main target for your app. CODE_SIGNING_TEAM_ID - this value will match your team id in the apple developer membership.

Match

MATCH_GIT_BRANCH = "master" MATCH_GIT_URL - this value will match the git url for the created code signing repo. MATCH_KEYCHAIN_NAME = "orgcrumpdxclientexample"

Gym

GYM_RELEASE_APP_BUNDLE_IDENTIFIER - this value GYM_RELEASE_PROVISIONING_PROFILE = "match AppStore org.cru.mpdxclientexample" GYM_RELEASE_SCHEME = "MPDXClientExampleSwiftPackageManager"

Fastlane Match

This step will involve creating a private repository for storing your distribution certificate and provisioning profile for code signing. Fastlane utilizes Match for sharing one code signing identity across your development team.

For more information on the benefits of storing your code signing credentials in a private repository see (https://codesigning.guide/).

For instructions on setting up Fastlane Match see (https://docs.fastlane.tools/actions/match/).

Once Fastlane Match is setup, you will need to add the created private repository git url to a couple files in your fastlane folder.

  • In your Matchfile, add the giturl with your created private repository git url.
  • In your .env.default set the MATCH_GIT_URL value to your private repository git url.