codeinwp/optimole-laravel

Integrate Optimole cloud-based image optimization service with your Laravel application

dev-main 2024-06-27 19:03 UTC

Requires

• codeinwp/optimole-sdk: ^1.2
• illuminate/support: ^9.0|^10.0|^11.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.0
• laravel/framework: ^9.0|^10.0|^11.0
• orchestra/testbench: ^7.0|^8.0|^9.0
• phpstan/phpstan: ^1.0

MIT

• Optimole Team

README

Requirements

• Laravel >= 9.0

Installation

Install the Optimole Laravel Package in your project using composer:

$ composer require codeinwp/optimole-laravel

If you want, you can publish Optimole's configuration file using the vendor:publish command:

$ php artisan vendor:publish --tag="optimole-config"

Configuration

The Optimole package will remain inactive until you provide an Optimole API key. You can do this by adding the OPTIMOLE_KEY variable to your .env file:

OPTIMOLE_KEY=your-optmole-api-key

If you don't have an API key, you can create an account on Optimole and get your API key.

Usage

By default, the Optimole Laravel Package will optimize all images and assets in your Laravel application if they use the asset helper function. The package also provides two helper functions that you can use in your blade templates. The optimole_asset function will return the URL of the optimized CSS or JS files, while the optimole_image function will return the URL of the optimized image.