https://github.com/scode-njnjas/react-native-converted-in-sdk
A React Native SDK for ConvertedIn, providing easy integration of ConvertedIn's tracking and analytics features into your React Native application.
https://github.com/scode-njnjas/react-native-converted-in-sdk
android android-pixel-sdk com-github-convertedin converted-in convertedinmobilesdk events ios react-native sdk sdk-react-native tracking
Last synced: about 2 months ago
JSON representation
A React Native SDK for ConvertedIn, providing easy integration of ConvertedIn's tracking and analytics features into your React Native application.
- Host: GitHub
- URL: https://github.com/scode-njnjas/react-native-converted-in-sdk
- Owner: Scode-Njnjas
- License: mit
- Created: 2024-08-19T03:25:34.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-09T04:58:18.000Z (10 months ago)
- Last Synced: 2025-05-07T10:15:15.885Z (about 2 months ago)
- Topics: android, android-pixel-sdk, com-github-convertedin, converted-in, convertedinmobilesdk, events, ios, react-native, sdk, sdk-react-native, tracking
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/react-native-converted-in-sdk
- Size: 2.8 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# react-native-converted-in-sdk
A React Native SDK for ConvertedIn, providing easy integration of ConvertedIn's tracking and analytics features into your React Native application.
[](https://opensource.org/licenses/MIT) [](https://badge.fury.io/js/react-native-converted-in-sdk) [](https://www.npmjs.com/package/react-native-converted-in-sdk)
## 📹 Demo
| iOS | Android |
| -------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
|  |  |
## 🛠️ Requirements
- iOS 13.0 or higher
- Android 5.0 (API level 21) or higher
## 📦 Installation
Install the package using npm:
```bash
npm install react-native-converted-in-sdk
```
Or with yarn:
```bash
yarn add react-native-converted-in-sdk
```
### Follow these steps to complete the installation:
#### iOS
- Add `ConvertedinMobileSDK` to your `Podfile`:
```ruby
pod 'react-native-converted-in-sdk', :path => '../node_modules/react-native-converted-in-sdk'
```
- Run `pod install` inside the `ios` directory.
#### Android
- Add the following line to the `android/settings.gradle` file:
```gradle
include ':react-native-converted-in-sdk'
project(':react-native-converted-in-sdk').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-converted-in-sdk/android')
```
- Add the following line to the `android/app/build.gradle` file:
```gradle
implementation project(':react-native-converted-in-sdk')
```
- Sync your project with Gradle files by running:
```bash
./gradlew sync
```
## 🚀 Usage
### Manual Module Usage
1. **Import the module and initialize it in the root of your app:**
```jsx
import { initializeSDK } from 'react-native-converted-in-sdk';
initializeSDK({
pixelId: 'your_pixel_id',
storeUrl: 'your_store_url',
});
```
2. **Use the SDK methods in your components:**
```jsx
import { identifyUser } from 'react-native-converted-in-sdk';
const Component = () => {
React.useEffect(() => {
// Example usage of SDK functions
identifyUser("[email protected]", "+91", "9876543210");
}, []);
// Your component logic here
};
```
### Usage with Hook
1. **Wrap your app with `RNConvertInSDKProvider`:**
```jsx
export default function App() {
return (
);
}
```
2. **Use the `useConvertedInSdk` hook in your components:**
```jsx
import { useConvertedInSdk } from 'react-native-converted-in-sdk';
const Component = () => {
const { identifyUser } = useConvertedInSdk();
React.useEffect(() => {
// Example usage of SDK functions
identifyUser("[email protected]", "+91", "9876543210");
}, []);
// Your component logic here
};
```
## 📚 API Reference
### `RNConvertInSDKProvider`
| Prop | Type | Required | Description |
| ---------- | ------ | -------- | ------------------------- |
| `pixelId` | string | Yes | Your ConvertedIn pixel ID |
| `storeUrl` | string | Yes | Your store URL |
### `useConvertedInSdk`
Returns an object with the following methods:
| Method | Parameters | Return Type | Description |
| ----------------------- | ------------------------------------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| `isInitialized` | None | `boolean` | Returns whether the SDK has been initialized. |
| `initializeSDK` | `config: { pixelId: string, storeUrl: string }` | `Promise` | Initializes the SDK with the provided configuration. Call this as early as possible in your app's lifecycle. |
| `identifyUser` | `email: string, countryCode: string, phoneNumber: string` | `void` | Identifies a user with their email, country code, and phone number. This helps in tracking user-specific events and improving personalization. |
| `addEvent` | `eventName: string, currency: string, total: number, products: Product[]` | `void` | Adds a custom event with the specified name, currency, total, and products. This allows tracking specific actions or milestones in your app. |
| `viewContentEvent` | `currency: string, total: number, products: Product[]` | `void` | Tracks a view content event when a user views a product or content page. Includes details like currency, total value, and viewed products. |
| `addToCartEvent` | `currency: string, total: number, products: Product[]` | `void` | Tracks an add-to-cart event when a user adds items to their shopping cart. Includes details about the added products, total value, and currency. |
| `initiateCheckoutEvent` | `currency: string, total: number, products: Product[]` | `void` | Tracks the initiation of the checkout process. This event should be called when a user starts the purchasing process. |
| `purchaseEvent` | `currency: string, total: number, products: Product[]` | `void` | Tracks a completed purchase event. This should be called when a user successfully completes a transaction, including details of purchased products. |
| `registerEvent` | None | `void` | Tracks a user registration event. This should be called when a new user creates an account in your app. |
### `Product` Interface
| Property | Type | Description |
| ---------- | ------ | ------------------------------------- |
| `id` | number | The unique identifier of the product. |
| `quantity` | number | The quantity of the product. |
| `name` | string | The name of the product. |
## 🧪 Sample App
Check the `example` folder for a complete implementation example.
> [!NOTE]
> If you encounter an error while installing pods in `example/ios`, please refer to this solution: [https://stackoverflow.com/a/78874710/12355129](https://stackoverflow.com/a/78874710/12355129)
## 🛠️ Development
To develop the SDK locally:
1. Clone the repository.
2. Ensure you have the following environment set up:
- Node.js version 18 or higher.
- Yarn version 3 or higher (project version: 3.6.1).
- Java 17 or higher.
- For iOS development: Xcode 12.0 or higher. iOS deployment target 13.0 or higher.
- For Android development: Android Studio 4.0 or higher.
3. Install dependencies:
```bash
yarn install
```
4. Run the example app:
- iOS:
```bash
cd example/ios && pod install && cd ../..
yarn example ios
```
- Android:
```bash
yarn example android
```
## 🧪 Testing
Run tests with:
```bash
yarn test
```
## 🚨 Error Handling
If any SDK method is called before initialization, an error will be thrown with the message:
```txt
SDK must be initialized before calling this method.
```
Make sure to initialize the SDK using the `initializeSDK` method before invoking any other SDK methods.
## 🤝 Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## 📚 Official Documentation
For detailed information and advanced usage, refer to the official ConvertedIn SDK documentation:
- [Android Getting Started Guide](https://developer.converted.in/android/getting-started)
- [iOS Getting Started Guide](https://developer.converted.in/ios/getting-started)
## 📜 License
MIT