https://github.com/zelloptt/react-native-zello-sdk

https://github.com/zelloptt/react-native-zello-sdk

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zelloptt/react-native-zello-sdk
• Owner: zelloptt
• License: mit
• Created: 2024-08-09T00:07:30.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-09-17T22:47:18.000Z (about 2 months ago)
• Last Synced: 2024-09-18T20:53:55.399Z (about 2 months ago)
• Language: TypeScript
• Size: 1.74 MB
• Stars: 3
• Watchers: 12
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# react-native-zello-sdk

Zello SDK for React Native.

Our React Native SDK offers itself as a thin wrapper around our native iOS and Android SDK’s. It is built with TypeScript, and communicates with the native SDK’s via [React Native’s native module support](https://reactnative.dev/docs/native-modules-intro).

This repository contains both the React Native Bridge, as well as an example app to demonstrate usage.

To see an example of the React Native SDK, check out [the example folder](https://github.com/zelloptt/react-native-zello-sdk/tree/master/example).

The following instructions are for the installation of the SDK into your application - **not** for the example app.

## Prerequisites

A React Native application and environment.

A thorough understanding of Zello. The best place to get started is our [documentation](https://sdk.zello.com/).

## Installation

Install the package via NPM:

```sh

npm install @zelloptt/react-native-zello-sdk

```

### iOS

Before getting started, please reference the [iOS Installation Guide](https://sdk.zello.com/installation-guides/ios-installation-guide).

The main amendment to the guide is that there is no need to add the `ZelloSDK` as a pod directly to your project.

#### Troubleshooting

While setting up your Notification Service Extension, you may receive an error:

```

Cycle inside YourApp; building could produce unreliable results.

Cycle details:

→ Target ‘YourApp’

○ That command depends on command in Target ‘YourApp’: script phase “[CP-User] [RNFB] Core Configuration”

```

If you receive the above error, you should move the `Build Phases` phase named `Embed Foundation Extensions` to higher up in the order.

### Android

Before getting started, please reference the [Android Installation Guide](https://sdk.zello.com/installation-guides/android-installation-guide).

#### Dependencies

You may or may not need to add the repositories to your app's `build.gradle`:

```

repositories {

  google()

  mavenCentral()

  maven {

    url = uri("https://zello-sdk.s3.amazonaws.com/android/latest")

  }

}

```

#### Linking

Since the Zello Android SDK requires Hilt, and we must inject the `Zello` instance into the `ReactPackage`, the project does not work with autolinking.

As such, you will need to create a `ReactPackage` wrapper like this:

```kotlin

/// ZelloAndroidSdkPackage.kt

import com.facebook.react.ReactPackage

import com.facebook.react.bridge.NativeModule

import com.facebook.react.bridge.ReactApplicationContext

import com.facebook.react.uimanager.ViewManager

import com.zello.sdk.Zello

import com.zellosdk.ZelloAndroidSdkModule

import javax.inject.Inject

class ZelloAndroidSdkPackage @Inject constructor(private val zello: Zello) : ReactPackage {

  override fun createNativeModules(reactContext: ReactApplicationContext): List {

    return listOf(ZelloAndroidSdkModule(reactContext, zello))

  }

  override fun createViewManagers(reactContext: ReactApplicationContext): List> {

    return emptyList()

  }

}

```

Then, add it to the packages list:

```kotlin

/// MainApplication.kt

@HiltAndroidApp

class MainApplication : Application(), ReactApplication {

    @Inject lateinit var zello: Zello

    override val reactNativeHost: ReactNativeHost =

      object : DefaultReactNativeHost(this) {

        override fun getPackages(): List =

            PackageList(this).packages.apply {

              // Packages that cannot be autolinked yet can be added manually here, for example:

              add(ZelloAndroidSdkPackage(zello))

            }

        override fun getJSMainModuleName(): String = "index"

        override fun getUseDeveloperSupport(): Boolean = BuildConfig.DEBUG

        override val isNewArchEnabled: Boolean = BuildConfig.IS_NEW_ARCHITECTURE_ENABLED

        override val isHermesEnabled: Boolean = BuildConfig.IS_HERMES_ENABLED

      }

      override fun onCreate() {

        super.onCreate()

        // Don't forget to start the SDK!

        zello.start()

      }

}

```

## Contributing

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.

## License

MIT

---

Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)