Skip to main content

iOS - Setup

Setting up your development environment correctly is essential to building and testing modules with the Q2 Mobile SDK. This section walks you through the tools, configurations, and initial steps required to begin development.

Use the following pages to get everything installed and configured before you start building modules.

Prerequisites​

Confirm your machine, network, and Q2 accounts are ready before writing any code.

  • System requirements (macOS version, RAM, disk)
  • Required software (Xcode, Git)
  • Network and firewall requirements (hosts, ports, proxy, custom CA)
  • Accounts and access (Q2 Developer Portal, GitLab PAT, sandbox URL)
  • Pre-development checklist

🖥️ Environment Setup​

Install the essential tools to begin working with the Q2 Mobile SDK, including:

  • Xcode installation and configuration
  • GitLab access and token generation
  • Cloning repositories and integrating them in Xcode

🧰 Q2 Mobile CLI Setup​

Set up and install the Q2 Mobile CLI tool to automate module creation, test build builds, and release tagging.

  • Installation steps
  • Common commands
  • Managing CLI versions

🧪 DevApp Structure​

Configure the Q2 DevApp to load and test your local module in a near-production environment.

  • Modifying settings.json
  • Registering your module
  • Running with live feature flags and sandbox targets

⚡ Migration Guidance​

Review current migration guidance when Q2 communicates multi-release rollout changes that may affect how you prepare or validate your module.

  • Current release impact and timeline
  • Local Package.swift testing options
  • Swift Package migration references for MSDK modules

Unit Testing​

Add Swift package unit tests for your module and run them through the shared Q2DevApp scheme.

  • Swift package test target structure
  • Q2DevApp workspace and test plan setup
  • Local test and code coverage commands

🧱 Module Structure​

Learn how to structure and scaffold a new module using best practices.

  • Folder layout
  • Swift package structure
  • Public and private code organization
  • Resource management

This setup process ensures your development workflow is smooth, predictable, and aligned with Q2 Mobile SDK standards.