shebinleovincent/olasearch-laravel-scout

Laravel Scout Engine for Ola Search

1.1.0 2018-09-14 06:55 UTC

Requires

• php: ^5.3 || ^7.0
• laravel/scout: ^4.0
• shebinleovincent/olasearch-client-php: ^1.1

MIT

• Ola Search Team
• Shebin Leo Vincent

• search
• laravel
• scout
• Ola Search

README

This package is the Laravel Scout Engine for Ola Search.

Contents

• Installation
• Usage
• Notes
• Credits
• License

Installation

You can install the package via composer:

composer require shebinleovincent/olasearch-laravel-scout

Optionally, you can add the Scout service provider and the package service provider in the config/app.php file. Otherwise this can be done via automatic package discovery.

// config/app.php
'providers' => [
    ...
    Laravel\Scout\ScoutServiceProvider::class,
    ...
    OlaSearchScout\OlaSearchServiceProvider::class,
],

Setting up Ola Search configuration

You must have a API Key with Ola Search. If you don't have one, sign-up for a free account on Ola Search.

If you need help with this please refer to the Ola Search documentation

After you've published the Laravel Scout package configuration:

// config/scout.php
// Set your driver to olasearch
    'driver' => env('SCOUT_DRIVER', 'olasearch'),

...
    'olasearch' => [
        'id'  => env('OLASEARCH_PROJECT_ID', ''),
        'key' => env('OLASEARCH_API_KEY', ''),
    ],
...

Usage

Now you can use Laravel Scout as described in the official documentation

Notes

• Dev Branches are for development and are UNSTABLE (use on your own risk)!

Credits

• Shebin Leo Vincent
• Ola Team

License

The MIT License (MIT).