Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lam0819 authored Oct 17, 2024
1 parent ceef99a commit afeb6ea
Showing 1 changed file with 46 additions and 24 deletions.
70 changes: 46 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,42 @@
# This is my package filament-panphp
<p align="center"><a href="https://solutionforest.com" target="_blank"><img src="https://github.com/solutionforest/.github/blob/main/docs/images/sf.png?raw=true" width="200"></a></p>


## About Solution Forest

[Solution Forest](https://solutionforest.com) Web development agency based in Hong Kong. We help customers to solve their problems. We Love Open Soruces.

We have built a collection of best-in-class products:

- [VantagoAds](https://vantagoads.com): A self manage Ads Server, Simplify Your Advertising Strategy.
- [GatherPro.events](https://gatherpro.events): A Event Photos management tools, Streamline Your Event Photos.
- [Website CMS Management](https://filamentphp.com/plugins/solution-forest-cms-website): Website CMS Management



# Filament UI for Pan Analytics

[![Latest Version on Packagist](https://img.shields.io/packagist/v/solution-forest/filament-panphp.svg?style=flat-square)](https://packagist.org/packages/solution-forest/filament-panphp)
[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/solution-forest/filament-panphp/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/solution-forest/filament-panphp/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/solution-forest/filament-panphp/fix-php-code-styling.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/solution-forest/filament-panphp/actions?query=workflow%3A"Fix+PHP+code+styling"+branch%3Amain)
[![Total Downloads](https://img.shields.io/packagist/dt/solution-forest/filament-panphp.svg?style=flat-square)](https://packagist.org/packages/solution-forest/filament-panphp)


Seamlessly integrate [pan, the lightweight and privacy-focused PHP product analytics library](https://github.com/panphp/pan), into your Filament admin panel with this powerful UI package.


<img width="636" alt="image" src="https://github.com/user-attachments/assets/a6599da8-49a8-4794-ae09-1be7a05229a7">


Key Features:
- Easy-to-use Filament components for visualizing Pan analytics data
- Intuitive interface for managing and configuring tracked elements
- Real-time dashboard for monitoring impressions, hovers, and clicks
- Integration with Filament's existing components and styling

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.
With our Filament UI for Pan, you can:
- Quickly view and analyze data collected via the `data-pan` attribute
- Easily manage allowed analytics and configure tracking limits
- Visualize trends and patterns in user interactions

## Installation

Expand All @@ -17,38 +46,31 @@ You can install the package via composer:
composer require solution-forest/filament-panphp
```

You can publish and run the migrations with:

```bash
php artisan vendor:publish --tag="filament-panphp-migrations"
php artisan migrate
```
## Usage

You can publish the config file with:

```bash
php artisan vendor:publish --tag="filament-panphp-config"
```
```php

Optionally, you can publish the views using
use SolutionForest\FilamentPanphp\Components\PanOverview;

```bash
php artisan vendor:publish --tag="filament-panphp-views"
public function panel(Panel $panel): Panel
{
return $panel
// ...
->widgets([
PanOverview::class
])
}
```

This is the contents of the published config file:

```php
return [
];
```
## Screenshot

## Usage
<img width="636" alt="image" src="https://github.com/user-attachments/assets/a6599da8-49a8-4794-ae09-1be7a05229a7">
<img width="927" alt="image" src="https://github.com/user-attachments/assets/5554edd2-9caa-46d0-be67-60f5179ec472">
<img width="920" alt="image" src="https://github.com/user-attachments/assets/4870684b-5e62-4834-a4db-89fecf75d199">

```php
$filamentPanphp = new SolutionForest\FilamentPanphp();
echo $filamentPanphp->echoPhrase('Hello, SolutionForest!');
```

## Testing

Expand Down

0 comments on commit afeb6ea

Please sign in to comment.