README

A powerful Laravel package for interacting with the Browserless API, providing an elegant way to take screenshots, generate PDFs, analyze performance, and automate browser tasks.

Installation

1. Install the package via Composer:

composer require millerphp/laravel-browserless

1. Publish the configuration file:

php artisan vendor:publish --provider="MillerPHP\LaravelBrowserless\BrowserlessServiceProvider"

1. Configure your environment variables in .env:

BROWSERLESS_API_KEY=your_api_key
BROWSERLESS_API_URL=https://chrome.browserless.io

Quick Start

Take a screenshot:

use MillerPHP\LaravelBrowserless\Facades\Browserless;

$screenshot = Browserless::screenshot()
    ->url('https://example.com')
    ->send();

Generate a PDF:

$pdf = Browserless::pdf()
    ->url('https://example.com')
    ->send();

Analyze performance:

$performance = Browserless::performance()
    ->url('https://example.com')
    ->send();

$score = $performance->categoryScore('performance');

Documentation

• Installation Guide - Detailed installation and setup instructions
• Usage Guide - Basic usage examples and common features
• API Reference - Comprehensive API documentation
• Configuration - Configuration options and environment variables
• Advanced Usage - Advanced features and customization
• Testing - Testing your Browserless integrations
• Troubleshooting - Common issues and solutions
• Security - Security best practices
• Performance - Performance optimization guide

Features

• Screenshots: Capture full-page or element-specific screenshots
• PDF Generation: Convert web pages to PDFs with custom options
• Performance Analysis: Analyze website performance using Lighthouse
• Browser Automation: Execute complex browser tasks using BQL
• Custom Options: Fine-tune every aspect of your requests
• Error Handling: Comprehensive error handling and logging
• Testing Support: Built-in testing utilities and mocking
• Security: Secure configuration and API key management
• Performance: Caching, batch processing, and resource optimization

Requirements

• PHP 8.1 or higher
• Laravel 9.0 or higher
• Composer

License

This package is open-sourced software licensed under the MIT license.