algolia/scout-extended

Scout Extended extends Laravel Scout adding algolia-specific features

v3.1.0 2024-03-21 14:34 UTC

Requires

• php: ^8.0
• ext-json: *
• algolia/algoliasearch-client-php: ^3.0.0
• illuminate/console: ^9.0|^10.0|^11.0
• illuminate/contracts: ^9.0|^10.0|^11.0
• illuminate/database: ^9.0|^10.0|^11.0
• illuminate/filesystem: ^9.0|^10.0|^11.0
• illuminate/support: ^9.0|^10.0|^11.0
• laravel/scout: ^9.0|^10.0
• riimu/kit-phpencoder: ^2.4

Requires (Dev)

• fakerphp/faker: ^1.13
• laravel/legacy-factories: ^1.1
• mockery/mockery: ^1.4
• nunomaduro/larastan: ^1.0|^2.0
• orchestra/testbench: ^4.9|^5.9|^6.6|^7.0|^8.0|^9.0
• phpstan/phpstan: ^1.3
• phpunit/phpunit: ^8.0|^9.0|^10.5

Suggests

• ext-dom: Required to use the HTML Splitter.

MIT

• Nuno Maduro
• Algolia Team

• search
• analytics
• laravel
• places
• extended
• algolia
• scout

README

Documentation • Community Forum • Stack Overflow • Report a bug • FAQ • Support

To dig right in, visit the Scout Extended documentation.

Scout Extended provides the perfect starting point to integrate Algolia into your Laravel application. It is carefully crafted to simplify the usage of Algolia within the Laravel Framework.

It’s built on top of the latest release of Laravel Scout, the official Laravel search package. Using Scout Extended, you are free to take advantage of all of Laravel Scout’s great features, and at the same time leverage the complete set of Algolia’s search experience.

✨ Features

• Zero downtime reimports - it’s a breeze to import data in production.
• Implement site-wide search amongst multiple models with aggregators.
• Automatically improve the relevancy of your search results.
• Beautiful overview of your application indexes.
• A useful collection of macros, facades, and much more.

💡 Documentation

For full documentation, visit the Scout Extended documentation.

Note: This package adds functionalities to Laravel Scout, and for this reason, we encourage you to read the Scout documentation first. Documentation for Scout can be found on the Laravel website.

Because everyone should be able to build great search, you can use Algolia's basic Community Plan. It's free up to a certain number of records and operations.

Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the package.

Use the Dockerfile

If you want to contribute to this project without installing all its dependencies, you can use our Docker image. Please check our dedicated guide to learn more.

🆓 License

Scout Extended is an open-sourced software licensed under the MIT license.