Pan开源项目安装与配置指南

Pan开源项目安装与配置指南

pan A simple, lightweight, and privacy-focused product analytics php package 项目地址: https://gitcode.com/gh_mirrors/pan2/pan

1. 项目基础介绍

Pan 是一个轻量级且注重隐私的 PHP 产品分析库。它被设计为一个非常简单的包，可以通过 Composer 安装，并开始追踪你的页面或组件，只需添加一个 data-pan 属性即可。Pan 目前仅追踪以下事件：展示（impressions）、悬停（hovers）和点击（clicks）。它不会收集任何个人信息，如 IP 地址、用户代理或任何可用于识别用户的数据。

主要编程语言：PHP、TypeScript、JavaScript。

2. 关键技术与框架

• PHP: 项目的主要后端编程语言。
• TypeScript/JavaScript: 用于编写客户端的 JavaScript 库，用于监听和发送事件数据。
• Laravel: Pan 与 Laravel 框架无缝集成，可以使用 Laravel 的 Artisan 命令和中间件。
• blade: Laravel 的模板引擎，用于在视图文件中快速添加 data-pan 属性。

3. 安装与配置

准备工作

• 确保你的系统安装了 PHP 8.3 或更高版本。
• 安装了 Laravel 11.0 或更高版本的框架。
• 确保你的项目中已经安装了 Composer。

安装步骤

1. 通过 Composer 安装 Pan

   在你的 PHP 项目根目录下运行以下命令：

   composer require panphp/pan
   

2. 在 Laravel 项目中安装 Pan

   使用 Artisan 命令安装 Pan：

   php artisan install:pan
   

3. 配置路由前缀（可选）

   如果需要，可以修改 Pan 的路由前缀。在 config/pan.php 文件中设置 routePrefix：

   PanConfiguration::routePrefix('your-custom-route-prefix');
   

4. 添加 data-pan 属性到 HTML 元素

   为了开始追踪页面或组件，需要在你想要追踪的 HTML 元素上添加 data-pan 属性。例如：

   <button data-pan="button-click">点击我</button>
   

5. 可视化产品分析

   使用 Artisan 命令查看追踪的数据：

   php artisan pan
   

   如果需要筛选特定的事件，可以使用 --filter 参数：

   php artisan pan --filter=your-event-name
   

6. （可选）设置白名单和限制

   为了防止恶意用户创建不必要的事件记录，可以通过白名单设置允许追踪的事件：

   PanConfiguration::allowedAnalytics(['event-name-1', 'event-name-2']);
   

   或者设置事件记录的最大数量：

   PanConfiguration::maxAnalytics(10000);
   

   如果你想不受数量限制，可以使用：

   PanConfiguration::unlimitedAnalytics();
   

7. 清理事件数据

   如果你需要清理数据库中的事件数据，可以使用以下命令：

   php artisan pan:flush
   

以上步骤将帮助你在 Laravel 项目中成功安装和配置 Pan 分析库。按照这些指南操作，你可以开始收集用户与你的应用程序的互动数据，进而优化用户体验。

pan A simple, lightweight, and privacy-focused product analytics php package 项目地址: https://gitcode.com/gh_mirrors/pan2/pan