Public Preview - This version is in public preview and subject to changes. For production use, please use SDK v4.

​
Prerequisites

Ditto’s Swift Quickstart supports iOS. Before getting started, ensure you have the following:

  • A macOS machine with the latest version of Xcode (15 or later) installed
  • A code editor (Xcode is recommended)
  • Git installed on your machine
  • A Ditto Portal account with a configured Ditto Application (see Getting SDK Connection Details)
  • A physical iOS device or an iOS simulator for testing

​
Get Started

​
1. Clone the Repository

  1. Open the terminal
  2. Clone the repository from GitHub.
    git clone https://github.com/getditto/quickstart
  3. Navigate to the project directory:
    cd quickstart

​
2. Configure Ditto

​
Get Ditto App ID, Playground Token, Auth URL, and Websocket URL

  1. Log in to your Ditto Portal account
  2. Navigate to your application and obtain the Ditto App ID, Playground Token, Auth URL, and Websocket URL. (see Getting SDK Connection Details for more details)

​
Add Ditto Credentials

  1. Copy the .env.sample file at the top level of the quickstart repo to .env and add your app ID and online playground token. 
    cp .env.sample .env
  2. Update the .env file with the App ID and Playground Token from your Ditto Application 
    DITTO_APP_ID="REPLACE_ME_WITH_YOUR_APP_ID"
DITTO_PLAYGROUND_TOKEN="REPLACE_ME_WITH_YOUR_PLAYGROUND_TOKEN"
DITTO_AUTH_URL="REPLACE_ME_WITH_YOUR_AUTH_URL"
DITTO_WEBSOCKET_URL="REPLACE_ME_WITH_YOUR_WEBSOCKET_URL"

​
3. Run the Application

  1. Launch Xcode and open the swift/Tasks.xcodeproj project.
  2. Configure Signing & Capabilities
    • Navigate to the Signing & Capabilities tab in the project settings.
    • Set the Team and update the Bundle Identifier to match your Apple Developer account for provisioning.
  3. Select a Build Target
    • In Xcode, choose a connected iOS device or an iOS Simulator as the run destination.
  4. Build the Application
    • From the Xcode menu, select Product > Build.
    • This will generate an env.swift file using the values from your .env file and compile the app.
  5. Run the Application
    • Select Product > Run to launch the app on your selected device or simulator.

​
4. Sync-Data Offline

  1. Launch the application on multiple devices or simulators
  2. Disconnect from your current WiFi network while keeping WiFi enabled on the device to allow for LAN connections
  3. Add, edit, and delete tasks and experience offline collaboration!

​
Next Steps

All the Ditto Quickstart apps works together! Try running a quickstart app in other languages and see them all collaborate.

​
Additional Resources