martechmagicians / referhub
ReferHub 是一个模块化和可组合的推荐系统,旨在无缝生成和跟踪用户的推荐码。支持多种识别方法和灵活的事件跟踪系统,ReferHub 为跨不同平台管理推荐提供了一个可扩展的解决方案。
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
This package is auto-updated.
Last update: 2024-09-05 00:23:23 UTC
README
ReferHub 是一个模块化和可组合的推荐软件,旨在生成和管理推荐码、跟踪事件和处理 webhook。采用 Symfony 构建,遵循 DDD 和 TDD 原则,ReferHub 为开发者和企业提供了一个灵活且易于维护的解决方案。
特性
- 推荐码生成:为通过电子邮件、用户名或 userId 识别的用户生成推荐码。
- 事件跟踪:跟踪通用事件,如注册、购买等。
- Webhook 集成:在跟踪事件发生时触发 webhook。
- CLI、REST 和批量 API 支持:灵活的 API 接口,满足各种集成需求。
- 开源:贡献和定制以满足您独特的需求。
安装
要求
- Docker(运行项目必需)
步骤
-
克隆仓库
git clone https://github.com/yourusername/referhub.git
-
导航到项目目录
cd referhub
-
配置环境变量:将
.env
文件复制到.env.local
文件,并添加您的数据库和其他配置。 -
构建项目
make build
-
运行容器
make up
-
创建数据库
make db-create
-
运行数据库迁移
make db-migrate
使用
有关通过 REST API 与 ReferHub 交互的详细信息,请参阅 API 文档。
贡献
我们欢迎贡献!
支持
如需支持,请打开 GitHub 上的问题或联系维护者。
许可
ReferHub 在 GNU 许可证 下发布。
致谢
特别感谢社区以及为该项目做出贡献的每一个人。