Snabble

snabble - the self-scanning and checkout platform.

Installation

CocoaPods

Snabble is available through CocoaPods, v1.7.0 or later is required. To install snabble, add the following line to your Podfile:

pod 'Snabble'

If you only need the core functionality without any UI components, use

pod 'Snabble/Core'

instead. As with all cocoapods written in Swift, make sure you have use_frameworks! in your Podfile.

Optional components

In order to use the twint and postFinanceCard payment methods, you will also need to include pod 'Snabble/Datatrans' in your app's Podfile. During the app's initialization phase you will then need to call DatatransFactory.initialize() with your app's registered URL scheme to make these methods available.

Note that support for these payment methods also requires changes to your app's Info.plist as described in Datatrans' SDK documentation, as well as adding a URL scheme that can be used to pass data back to your app, e.g. by adding

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleTypeRole</key>
    <string>Editor</string>
    <key>CFBundleURLName</key>
    <string>YOUR_URL_NAME_HERE</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>YOUR_URL_SCHEME_HERE</string>
    </array>
  </dict>
</array>

Carthage

Carthage is currently unsupported. This is because one of the dependencies we use (GRDB.swift) does not reliably build using Carthage, as documented in their README. If and when this issue gets resolved, you should be able to use the provided Cartfile.

SPM

SPM is currently unsupported, as some of our dependencies do not support it (yet). As soon as they do, we will look into SPM support again.

Manually

Build the example project, as described below, and copy the following frameworks and bundles to your app's target:

• Snabble.framework
• GRDB.framework
• OneTimePassword.framework
• Base32.framework
• TrustKit.framework
• Zip.framework
• Snabble.bundle
• SDCAlertView.framework
• ColorCompatibility.framework
• Capable.framework
• DeviceKit.framework
• Pulley.framework

Versioning

Snabble follows semantic versioning rules. Note that we are currently in initial development, with major version 0. Anything may change at any time.

Documentation

https://snabble.github.io/iOS-SDK/

Example project

The Example folder contains an extremely simple example for an app. To compile:

$ git clone https://github.com/snabble/iOS-SDK
$ cd iOS-SDK/Example
$ pod install
$ open SnabbleSampleApp.xcworkspace

To run this sample app, you will need an application identifier and a corresponding secret. Contact us via e-mail for this information.

Author

snabble GmbH, Bonn https://snabble.io

License

snabble is (c) 2021 snabble GmbH, Bonn. The SDK is made available under the MIT License.