Skip to content

Latest commit

 

History

History
122 lines (88 loc) · 4.33 KB

README.md

File metadata and controls

122 lines (88 loc) · 4.33 KB
Raw

🌤 React Native Gigya SDK

SAP CDC/Gigya SDK for your React Native applications.

Current GitHub Actions build status. Current npm package version. Monthly npm downloads. PRs welcome!

🏗️ Installation

  1. Install the library :
yarn add react-native-gigya-sdk base-64
  1. If you haven't done so already, install a persistent storage library (like EncryptedStorage) as you'll need to provide it during setup. Just make sure your library exposes getItem() and setItem() functions.

iOS

See steps
  1. Add the following line to your ios/Podfile:
pod 'Gigya'
  1. From /ios, run:
pod install
  1. If you don't already have a Swift file in your project, via Xcode, create a .swift file (ie: Bridge.swift) in your Xcode workspace and accept to Create Bridging Header:
//
//  Bridge.swift
//  GigyaSdkExample
//

import Foundation
  1. If you're planing on providing social login, search for the "Facebook", "Google", etc section and follow the full documentation to install and set up its SDK. You can then open Xcode and add its Wrapper.swift file to your target (inside Compile Sources from the Build Phases tab) to handle the communication with the Gigya SDK. The file is available inside the GigyaProviders.zip asset that comes with each gigya-swift-sdk release.

Android

See steps
  1. Add the desired Gigya SDK version to your android/build.gradle:
buildscript {
    ext {
      gigyaCoreSdkVersion = "7.1.1"
    }
}
  1. If you're planing on providing social login, search for the "Facebook", "Google", etc section and follow the full documentation to install and set up the social provider SDK.

💻 Usage

You can now initialize the SDK with your apiKey, dataCenter, application lang, storage solution & desired storageKey.

❗ Please make sure your storage library exposes getItem() and setItem() functions or provided them yourself.

import EncryptedStorage from 'react-native-encrypted-storage'
import GigyaSdk, { GigyaSdkDataCenterEnum } from 'react-native-gigya-sdk'

// Before anything we initialize the SDK.
GigyaSdk.init({
  lang: 'en',
  storage: EncryptedStorage,
  storageKey: 'RANDOM_STRING'
  apiKey: 'INSERT_GIGYA_API_KEY',
  dataCenter: GigyaSdkDataCenterEnum.EU1,
})

// Now we can use it.
const myAccount = await GigyaSdk.login(email, password)

🤝 Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

📰 License

MIT