Download Swift Samples

Download the Swift SDK and try out the sample apps

This section shows how to download the Swift SDK bundled with our sample projects.

We recommend you first try our sample apps on this page before going to the CocoaPods step.

There are 2 ways to download the Swift SDK with our open sourced sample code. Each is documented below.

Download Method

Recommended Usage

Download the SDK package as a tar.gz (Recommended)

Getting started with Placenote

Clone the Github Repository

For developers who want to fork or contribute to the code base.

Method 1: Download the SDK .tar.gz package

This is the easiest method to get started with the Swift SDK

Step 1: Download the SDK files

Step 2: Open the workspace in Xcode

Unzip and open the folder. Look for the PlacenoteSDKExample.xcworkspace file and double click it to open in Xcode.

Open the PlacenoteSDKExample.xcworkspace fie

We recommend XCode 10.2 and later for this project.

Method 2: Clone the Github Repo

Github Repository: https://github.com/Placenote/PlacenoteSDK-iOS

We recommend you use "git clone" to get the repository from Github, but please follow the instructions below to correctly download the repository because we use git LFS for some large files.

Important Note!

When downloading source, DO NOT download the source as a zip file. This will NOT get you the core library files (stored in git LFS).

If you're cloning the SDK from Github, it's very important to ensure that you have the Git LFS (Large file system) installed on your computer. Please follow the 4 Steps below:

Step 1: Ensure you have git LFS on your computer

To install using HomeBrew on Mac, open a terminal window and type:

brew install git-lfs

Step 2: Now clone the github repository like this:

git clone git@github.com:Placenote/PlacenoteSDK-iOS.git

Step 3: Ensure you have the right files

The SDK will be downloaded into a folder called PlacenoteSDK-iOS. Let's do a quick test to ensure you have downloaded the Placenote library using git lfs correctly. Open the PlacenoteSDK-iOS folder.

Now navigate to: Pods/PlacenoteSDK/Placenote.framework Right click on the .framework and click "Get Info". The size of this framework folder should be higher than 8MB.

Step 4: Open the workspace

In the PlacenoteSDK-iOS folder, look for the PlacenoteSDKExample.xcworkspace file and double click it to open in Xcode.

Open the PlacenoteSDKExample.xcworkspace fie

Done! You have successfully downloaded the SDK and opened up the Sample projects.