Sample apps

Each platform has a sample app that shows a complete integration: initialization, SSO, navigation, theming and more. Run it with your own API key to see the community working before you integrate it in your app.

Before you begin

• An API key for a sandbox community. Request one from the form on octopuscommunity.com.
• To sign users in with SSO, a way to get a user token: either your community's token secret, used by some samples to sign a JWT locally, or a JWT from your backend. See Generate a signed JWT.
• The toolchain of your platform: see Requirements.

danger

Some samples sign the SSO JWT inside the app with your community's token secret, only to make the demo self-contained. Never put this secret in an app you ship: anyone could extract it and sign in as any user. In your app, the JWT always comes from your backend.

Which sample shows what

Platform	Repository	What it covers
Android	octopus-sdk-android	One build variant per navigation pattern, plus theming, SSO, bridges and push notifications.
iOS	octopus-sdk-swift	Modal and tab integrations, SSO in the Account tab, and scenarios such as theming, bridges and events in the More tab.
Flutter	octopus-sdk-flutter	The example app, with SSO and the reactive APIs.
React Native	octopus-sdk-react-native	The example app, whose Scenarios tab walks through most of the reactive and analytics APIs.
Unity	octopus-sdk-unity	The UnityExample project, and importable samples for Octopus authentication, push notifications and groups.

---

Run the sample

Android

The samples module has one build variant per navigation pattern: singleactivity, fullscreen, bottomnavigationbar, nestednavigation, contentpadding and modalbottomsheet. It needs JDK 17 and an Android SDK, or Android Studio.

1. Clone the repository and add your API key to local.properties at its root:

   git clone https://github.com/Octopus-Community/octopus-sdk-android.git && cd octopus-sdk-android
   echo "OCTOPUS_API_KEY=YOUR_API_KEY" >> local.properties

2. To sign users in with SSO, also add your community's token secret. The sample uses it to sign the JWT locally:

   OCTOPUS_SSO_CLIENT_USER_TOKEN_SECRET=YOUR_TOKEN_SECRET

3. Install the variant that matches your navigation, for example:

   ./gradlew :samples:installFullscreenDebug

Each variant's entry point is samples/src/<variant>/java/com/octopuscommunity/sample/screens/MainScreen.kt.

iOS

The sample lives in the same repository as the SDK.

1. Clone the repository and create your secrets file from the template:

   git clone https://github.com/Octopus-Community/octopus-sdk-swift.git && cd octopus-sdk-swift
   cp Sample/OctopusSample/Config/secrets.placeholder.xcconfig Sample/OctopusSample/Config/secrets.xcconfig

2. In secrets.xcconfig, set OCTOPUS_API_KEY to your API key. If your community uses SSO, also set CLIENT_USER_TOKEN_SECRET to your community's token secret: the sample uses it to sign the JWT locally.

3. Open Sample/OctopusSample.xcworkspace. In OctopusSDKProvider, uncomment the call in initializeSDK that matches your community's connection mode.

4. Run the OctopusSample scheme. Connect a user from the Account tab. The Modal and Octo Tab tabs show two ways to present the community, and More lists the other scenarios.

Flutter

1. Clone the repository and install the dependencies of the example:

   git clone https://github.com/Octopus-Community/octopus-sdk-flutter.git && cd octopus-sdk-flutter/example
   flutter pub get

2. Run the example with your credentials. OCTOPUS_USER_ID and OCTOPUS_USER_TOKEN, a JWT from your backend, are needed only to try SSO:

   flutter run \
     --dart-define=OCTOPUS_API_KEY=YOUR_API_KEY \
     --dart-define=OCTOPUS_USER_ID=YOUR_TEST_USER_ID \
     --dart-define=OCTOPUS_USER_TOKEN=YOUR_JWT

The app launches without a key too: the Home tab then reports an initialization error.

React Native

1. Clone the repository and install the dependencies from its root, which also installs the example:

   git clone https://github.com/Octopus-Community/octopus-sdk-react-native.git && cd octopus-sdk-react-native
   yarn

2. Create your environment file from the template, then set OCTOPUS_COMMUNITY_API_KEY in it. To try SSO, also set OCTOPUS_SSO_USER_ID and OCTOPUS_SSO_USER_TOKEN, a JWT from your backend:

   cp example/.env.dist example/.env

3. Build and run the example:

   yarn example android
   # On iOS, install the pods first:
   yarn example ios:pod && yarn example ios

Unity

• Full sample: clone octopus-sdk-unity and open the UnityExample folder in Unity. Create a configuration with Assets > Create > Octopus Example Config, set your API key in it, then build for Android or iOS.
• Focused samples: in your own project, open Window > Package Manager > Octopus SDK for Unity > Samples and import Octopus Auth Example, Push Notifications Example or Groups Example.

To try the SDK in the Editor without a device build, see Unity Editor Mock Mode.

Next steps

• Quickstart: integrate the SDK in your own app.
• Connect your users: replace the sample's local JWT signing with your backend.
• Generate a signed JWT: the backend route that signs user tokens.