martechmagicians/referhub

ReferHub is a modular and composable referral system, designed to seamlessly generate and track referral codes for users. With support for various identification methods and a flexible event-tracking system, ReferHub provides an extensible solution for managing referrals across different platforms.

v1.0.0 2023-08-04 21:55 UTC

Requires

• php: >=8.2
• ext-ctype: *
• ext-iconv: *
• doctrine/doctrine-bundle: ^2.10
• doctrine/doctrine-migrations-bundle: ^3.2
• doctrine/orm: ^2.15
• phpdocumentor/reflection-docblock: ^5.3
• phpstan/phpdoc-parser: ^1.23
• symfony/console: 6.3.*
• symfony/dotenv: 6.3.*
• symfony/flex: ^2
• symfony/framework-bundle: 6.3.*
• symfony/http-client: 6.3.*
• symfony/property-access: 6.3.*
• symfony/property-info: 6.3.*
• symfony/runtime: 6.3.*
• symfony/serializer: 6.3.*
• symfony/yaml: 6.3.*

Requires (Dev)

• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-symfony: ^1.3
• phpunit/phpunit: ^9.5
• symfony/browser-kit: 6.3.*
• symfony/css-selector: 6.3.*
• symfony/maker-bundle: ^1.50
• symfony/phpunit-bridge: ^6.3

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php72: *
• symfony/polyfill-php73: *
• symfony/polyfill-php74: *
• symfony/polyfill-php80: *
• symfony/polyfill-php81: *

proprietary

README

ReferHub is a modular and composable referral software designed to generate and manage referral codes, track events, and handle webhooks. Built with Symfony and following DDD and TDD principles, ReferHub offers a flexible and maintainable solution for developers and businesses.

Features

• Referral Code Generation: Generate referral codes for users identified by email, username, or userId.
• Event Tracking: Track generic events like Sign Up, Purchase, and more.
• Webhook Integration: Trigger webhooks when tracked events occur.
• CLI, REST, and Batch API Support: Flexible API interfaces for various integration needs.
• Open Source: Contribute and customize to fit your unique requirements.

Installation

Requirements

• Docker (required to run the project)

Steps

1. Clone the Repository:

   git clone https://github.com/yourusername/referhub.git

2. Navigate to the Project Directory:

   cd referhub

3. Configure Environment Variables: Copy the .env file to the .env.local file with your database and other configurations.

4. Build the Project:

   make build

5. Run the containers :

   make up

6. Create the db:

   make db-create

7. Run db migrations:

   make db-migrate

Usage

Refer to the API documentation for details on interacting with ReferHub via REST API.

Contributing

We welcome contributions!

Support

For support, please open an issue on GitHub or contact the maintainers.

License

ReferHub is released under the GNU License.

Acknowledgments

Special thanks to the community and everyone who has contributed to this project.