iOS

Install Parse SDK on your iOS Swift Project

Introduction

In this section you will learn how to install Parse iOS SDK into your Xcode project.

In this tutorial we will use a basic app created in Swift with Xcode 9.1 and iOS 11.

At any time, you can access the complete Project built with this tutorial at our GitHub repository.

Prerequisites

To complete this tutorial, you need:

  • An app created at Back4App.
  • Xcode.
  • Basic iOS app.
    • Note: If you don’t have a basic app created you can open Xcode and hit File-> New-> Project. Then select single view app. After you create your basic app you are ready to follow this guide.

    Creating intial Xcode project

    Setting the project to single view app

Note: Parse iOS SDK works with iOS 7.0 or higher.

Step 1 - Install SDK

Follow this step if you haven’t yet installed Parse iOS SDK.

Xcode can use CocoaPods as dependency manager for Swift and Objective-C Cocoa projects.

You can refer to CocoaPods Getting Started Guide for additional details.

To install CocoaPods, open your terminal, copy the following code snippet and paste it in to your terminal and hit return:

$ sudo gem install cocoapods

CocoaPods should install automatically after you enter your password. If there’s a problem you may need to upgrade your local version of Ruby.

Next open up the Xcode Project folder and open a terminal window in that folder.

open terminal from project folder

Now you are going to create a Podfile. Copy the following code snippet and paste it in to your terminal and hit return:

$ pod init

If your folder now shows your Podfile you did it correctly.

project with podfile

Be careful, If you don’t see the podfile make sure your terminal is actually inside the project folder..

Next open your Podfile with Xcode or any text editor and under each target add “pod ‘Parse’”.

pod 'Parse'

add Parse to your Podfile

Now you are going to add Parse to your project. Make sure your terminal is opened to your project folder. Copy the following code snippet and paste it in to your terminal and hit return:

$ pod install

CocoaPods will rebuild the project as a workspace and your project will now look like this.

Workspace with Parse added

If you have already opened your Xcode project close it. From now on you’ll open the workspace file instead of the project file. Double click on the workspace file to open it.

Open Workspace file

Congratulations! You have now installed the Parse iOS SDK

Step 2 - Connect your Parse App

  1. Open your project’s AppDelegate.swift file to set up the app’s credentials.
  2. Parse iOS SDK uses these settings to connect to the Back4App servers.
  3. At the top of the file you should see a function called ‘didFinishLaunchingWithOptions’.
  4. Paste the following code snippet inside this function, and make sure it is above the line that says ‘return true’.

AppDelegate.swift

1
2
3
4
5
6
let configuration = ParseClientConfiguration {
    $0.applicationId = "PASTE_YOUR_APPLICATION_ID_HERE"
    $0.clientKey = "PASTE_YOUR_CLIENT_ID_HERE"
    $0.server = "https://parseapi.back4app.com"
}
Parse.initialize(with: configuration)

At the top of your AppDelegate.swift file make sure to include Parse as a module by including the follwing code snippet right below ‘import UIKit’.

AppDelegate.swift

1
    import Parse

Your AppDelegate.swift file should now look like this:

Open Workspace file

Be careful, If Xcode tells you there is No Such Module ‘Parse’ there’s an easy solution. In Xcode open ‘Target > Build Settings > Search Paths > Framework Search Paths’ and then add two values: ‘$(PROJECT_DIR)’ and ‘$(inherited)’. Xcode will now be able to find your Parse module.

  1. Go to your App Dashboard at Back4App website.
  2. Navigate to app’s settings: Click on Features > Core Settings block > Server.
  3. Return to your AppDelegate.swift file and paste your applicationId and clientKey.

See more at our New Parse App guide.

Step 4 - Test your connection

Open your AppDelgate.swift file. Inside the function called ‘didFinishLaunchingWithOptions’ add a snippet of code below the code that configures parse.

AppDelegate.swift

1
    saveInstallationObject()

Then add a snippet of code to AppDelegate.swift file just below ‘didFinishLaunchingWithOptions’to create a new parse installation object upon your app loading.

AppDelegate.swift

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
    func saveInstallationObject(){
        if let installation = PFInstallation.current(){
            installation.saveInBackground {
                (success: Bool, error: Error?) in
                if (success) {
                    print("You have successfully connected your app to Back4App!")
                } else {
                    if let myError = error{
                        print(myError.localizedDescription)
                    }else{
                        print("Uknown error")
                    }
                }
            }
        }
}

Your finished AppDelegate.swift file should look like this.

Open Workspace file

  1. Build your app in a device or simulator (Command+R).

    Build app

  2. Wait until the main screen appears.
  3. Login at Back4App Website.
  4. Find your app and click on Dashboard.
  5. Click on Core.
  6. Go to Browser.

If everything works properly, you should find a class named Installation as follows:

Installation at Back4App Dashboard

Next Steps

At this point, you have learned how to get started with iOS apps. You are now ready to explore Parse Server core features and Back4App add-ons.

Learn more by walking around our iOS Tutorials or check Parse open source documentation for iOS SDK.