README.md

Snabble

snabble - the self-scanning and checkout platform.

Introduction

Starting with the 0.22.2 release, Snabble officially supports installation via Swift Package Manager.

Prior to version 0.22.2 only Cocoapods is supported

Requirements

• Requires Xcode 15.4 or above
• Requires iOS 17.0 or above
• See Package.swift for supported platform versions.

Installing from Xcode

Add a package by selecting File → Add Packages… in Xcode’s menu bar.

Search for the Snabble Apple SDK using the repo's URL:

https://github.com/snabble/snabble-ios-sdk.git

Next, set the Dependency Rule to be Up to Next Major Version and specify 0.22.2 as the lower bound.

Then, select Add Package.

Choose the Snabble products that you want installed in your app.

Alternatively, add Firebase to a Package.swift manifest

To integrate via a Package.swift manifest instead of Xcode, you can add Firebase to the dependencies array of your package:

dependencies:[
  .package(
    name: "Snabble",
    url: "https://github.com/snabble/snabble-ios-sdk.git",
    .upToNextMajor(from: "0.22.2")
  )
]

Then, in any target that depends on a Firebase product, add it to the dependencies array of that target:

.target(
  name: "MyTargetName",
  dependencies: [
    // The product(s) you want (e.g. SnabbleCore).
    .product(name: "SnabbleCore", package: "Snabble"),
  ]
)

Optional components

In order to use the twint and postFinanceCard payment methods, you will also need to include 'SnabbleDatatrans' as package in your app. 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>

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://docs.snabble.io/docs/ios/

Example project

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

$ git clone https://github.com/snabble/snabble-ios-sdk
$ cd snabble-ios-sdk/Example
$ open SnabbleSampleApp.xcodeproj

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

What's new

With this version, the Scan&Go module SnabbleScanAndGo is available as a SwiftUI component. This extension allows you to integrate the entire Scan&Go workflow by simply calling ShopperView(model: Shopper).

To create a Shopper you must be checked into a Shop:

import SnabbleScanAndGo

final class AppState: ObservableObject {
   @Published var shop: Shop? {
        didSet {
            if let shop {
                self.shopper = Shopper(shop: shop)
            } else {
                self.shopper = nil
            }
        }
    }
   @Published var shopper: Shopper?
   ...
}

You can now start a Scan&Go session with a Shopper instance:

import SnabbleScanAndGo

public struct ShoppingContainer: View {
    @EnvironmentObject var appState: AppState
    
    public var body: some View {
        if let model = appState.shopper {
            ShopperView(model: model)
        } else {
            ShopperLoadingView()
        }
    }
}

All actions during a Scan&Go session are performed in ShopperView. This includes:

• Selection of a payment method that has not yet been configured with forwarding to the respective input form.
• Selection of an already configured payment method.
• Adding scanned items to the shopping basket.
• Managing the shopping cart (changing article quantities, deleting articles).
• Search mask for manual entry of barcodes.
• Performing a payment process with checkout.
• Error handling during a Scan&Go session

Author

snabble GmbH, Bonn https://snabble.io

License

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