install-shipbook

Install Shipbook

A full integration assistant for adding the Shipbook SDK to a project.

Steps

1. Detect or ask platform

Scan the project to detect the platform:

• Podfile or .xcodeproj → iOS
• build.gradle or build.gradle.kts → Android
• pubspec.yaml → Flutter
• react-native in package.json dependencies → React Native
• package.json with browser/web framework (react, vue, angular, svelte) → Browser
• package.json with node/express/nestjs/fastify → Node.js

If ambiguous, ask the user which platform.

2. Install SDK package

iOS (Swift Package Manager): Add the package dependency https://github.com/ShipBook/ShipBookSDK-iOS.git via Xcode or Package.swift.

Android (Gradle): Add to build.gradle dependencies:

implementation 'io.shipbook:shipbooksdk:1.+'

Flutter:

flutter pub add shipbook_flutter

React Native:

npm install @shipbook/react-native

Browser:

npm install @shipbook/browser

Node.js:

npm install @shipbook/node

3. Get or create app credentials

Call get-account-apps to list the user's apps (returns name, appId, platform, key, integration).

• If matching apps exist, ask the user which one to use
• If no apps exist or the user wants a new one, call create-app with a name to create one
• Use the returned appId and key to auto-populate the initialization code

4. Initialize the SDK

Add the import at the top of the file (with the other imports) and the start() call at the correct initialization point per platform:

iOS — import at top, start() in AppDelegate.application(_:didFinishLaunchingWithOptions:):

// top of file
import ShipBookSDK

// in didFinishLaunchingWithOptions
ShipBook.start(appId:"APP_ID", appKey:"APP_KEY")

Android — import at top, start() in Application.onCreate():

// top of file
import io.shipbook.shipbooksdk.ShipBook;

// in onCreate()
ShipBook.start(this, "APP_ID", "APP_KEY");