blynk-deferlink

Overview

blynk-deferlink is an open-source, self-hosted deferred deep linking and referral attribution solution specifically designed for React Native applications. This project serves as an alternative to Firebase Dynamic Links, providing essential features such as Android Install Referrer, iOS clipboard handoff, and fingerprint matching fallback, all powered by a PHP or Node.js backend.

Key Features

This repository includes four main packages, catering to different requirements:

• Referral SDK for PHP: A backend solution that stores clicks, matches tokens, and manages claims.
• Referral SDK for Node.js: Built on Express and Postgres, offering the same API contract as the PHP backend.
• Referral Web: A React-based landing page that utilizes referral hooks for seamless integration.
• Referral Mobile: A React Native library focused on token recovery and referral management.

Demonstration

The project is already in production use at Sparkle, a Nigerian microfinance bank. Users can experience a real-time referral flow by tapping a link from a mobile device, which leads to the installation of the app and automatically populates the referral code in the signup form when the app is launched for the first time. This seamless process highlights the capability of blynk-deferlink in handling deferred deep linking.

To witness it in action, visit this live demo.

How It Works

The referral flow operates through a combination of deterministic and probabilistic methods to enhance reliability:

1. Deterministic Recovery:

   • Android: Utilizes the Play Install Referrer to read codes and tokens directly on-device.
   • iOS: Employs clipboard payloads that survive the app installation, activated only if a designated button is pressed by the user.

2. Probabilistic Recovery:

   • This fallback mechanism utilizes a scoring system that accounts for user device characteristics, ensuring seamless code retrieval when the deterministic path is unfeasible.

This dual-system approach promotes a near-complete recovery of referral information, contributing to higher attribution accuracy.

Comparison with Other Solutions

blynk-deferlink differs from platforms like Branch and AppsFlyer in several significant ways:

• Self-Hosting: Users retain full control over their data, without vendor lock-in or reliance on external cloud services.
• Cost Efficiency: Operating costs are linked to hosting resources rather than monthly active users, making it scalable for various application sizes.
• Flexibility: As an open-source project, users can modify the codebase to fit their specific needs, facilitating enhanced customization.

Integration and Documentation

The README includes extensive documentation and quick start guides for developers keen on self-hosting the solution or leveraging it within their projects, ensuring a smooth integration process. Individual integration guides for each package provide step-by-step instructions on setting up the backend, web landing page, and mobile app functionalities.

For more detailed information, users can reference the decision-making log that encapsulates the engineering choices made throughout the development of this project, offering transparency about the underlying architecture.

Contributions

Contributions to the project are welcome, with clear guidelines in the CONTRIBUTING.md file. Developers are encouraged to help enhance the software by addressing issues and improving documentation.