dogado/mugshot

A small service that helps you take screenshots of web pages.

v0.4.1 2022-05-18 22:33 UTC

Requires

• php: ^8.0.2
• ext-exif: *
• ext-json: *
• guzzlehttp/guzzle: ^7.2
• laravel/framework: ^9.11
• laravel/sanctum: ^2.14.1
• laravel/tinker: ^2.7
• league/mime-type-detection: ^1.9
• sentry/sentry-laravel: ^2.4.0
• spatie/browsershot: ^3.52.3
• spatie/laravel-health: ^1.8

Requires (Dev)

• fakerphp/faker: ^1.14.1
• laravel/sail: 1.8
• mockery/mockery: ^1.4.4
• nunomaduro/collision: ^6.1
• nunomaduro/larastan: ^2.0
• phpunit/phpunit: ^9.5
• spatie/laravel-ignition: ^1.0

MIT

README

A small service that helps you take screenshots of web pages.

Requirements

• PHP 8
• MySQL
• Node for Puppeteer

Installation

git clone https://github.com/dogado/mugshot.git mugshot
composer install --no-dev -o

php artisan key:generate
php artisan migrate
php artisan storage:link

Mugshot uses Puppeteer in the background to create screenshots

npm install puppeteer --global

Usage

Capture Screenshot

POST /api/v1/screenshot

Status Check

GET /api/v1/status

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

The MIT License (MIT). Please see License File for more information.