README

本README指南中的信息完全为临时信息；这是一个正在开发的概念项目。目前根本不适合实际使用。非常抱歉！💔

UserKit是一个用于服务器端分析的PHP库，帮助您跟踪您的用户。一个强大的本地用户管理面板。它有点像Intercom，但完全是本地的。

以下是您可以使用UserKit做的酷炫事情

您可以通过Composer安装UserKit。这将设置库作为依赖项并安装自动加载器。

composer require roydejong/userkit

Userkit当前使用Browscap来收集用户代理数据，您需要下载最新的定义

vendor/bin/browscap-php browscap:update

就这些。您现在可以开始集成。

接下来，您需要将UserKit集成到您的应用程序中，以便它可以收集分析数据。

当您的应用程序启动时，您需要提供数据库配置。以下是连接到MySQL数据库时的样子

UserKit::configure()
    ->setConnectionString('mysql://user:pass@127.0.0.1/dbname?charset=utf8');

UserKit将自动在您连接到的数据库上安装和升级。

所有表都将以前缀userkit_开头。如果您想，可以创建一个单独的数据库，或者如果您不介意添加一些额外的表，可以使用现有的数据库。

要捕获请求，您只需调用capture()方法即可

UserKit::capture()

这将捕获并记录当前请求和环境数据作为单个传入请求，这将从开始为您提供一些基本的活动数据。

您可以通过添加更多数据来丰富捕获，以获得更有用的见解。例如，如果用户已登录，您可以附加一些数据

UserKit::capture()
    ->user([
        'id' => 1234,
        'name' => 'John Doe',
        'email' => 'john.doe@example.com'
    ])

注意：您可以多次调用capture()以向捕获添加更多数据。您的数据将仅记录一次。捕获在脚本关闭时或当您在捕获对象上手动调用flush()时保存到数据库中。

这里就是亮点：激活UserKit的Web UI以查看分析和获取用户见解。只需一点代码即可！

UserKit::webui()
    ->show()

UserKit会为您构建和渲染UI。就这么简单！

注意：保护此页面以保护用户隐私是您的责任。UserKit目前不提供任何身份验证功能。

roydejong / userkit