Installing the Volt Mobile SDK

Follow the instructions below to install the Volt Mobile SDK for Android and iOS as appropriate for your project.

  • Android
  • iOS

Gradle

Maven configuration is required for authorisation with our SDK package in Maven.  For that you need to enter a proper private token provided by Volt.  Please contact us at support@volt.io to request a token.

settings.gradle.kts
maven {
  url = uri("https://gitlab.com/api/v4/projects/49120335/packages/maven")
  credentials(HttpHeaderCredentials::class) {
    name = "Private-Token"
    value = "<private-token>"
  }

  authentication {
    create("header", HttpHeaderAuthentication::class)
  }
}
Module-level
build.gradle.kts
dependencies {
  implementation("io.volt:mobilesdk:1.0.0")
}

Volt SDK repository at GitLab

A project access token will be needed to authenticate and access the repository. Volt will provide a token to developers on request – please contact us at support@volt.io

Find out more about project access tokens

Command line
git clone https://[username]:[token]@gitlab.com/volt_developers/developers/frontend-team/checkout-team/mobile/voltsdk-ios.git
Manually download from GitLab
  • Clone the VoltSDK repository into any local folder
  • In your Xcode project, navigate to the project’s directories
  • Drag and drop the .xcframework into the Frameworks group or any relevant folder you want
  • Ensure that the framework is set to Embed & Sign in the General tab of the project

Using the Swift Package Manager
  • Open your Xcode project and navigate to File > Swift Packages > Add Package Dependency
  • Enter the GitLab URL of the SDK’s repository
  • Select the appropriate version or branch
  • Xcode will download the .xcframework and integrate it into your project