README

This package makes is the Taxus driver for Laravel Scout.

Requirements
Installation
Usage
Credits

Requirements

This package is based on laravel scout package, So please install scout v.4 before using taxus search engine.

Installation

You can install the package via composer:

composer require taxus-search/laravel-scout-driver

You must add the Scout service provider and the package service provider in your app.php config:

// config/app.php
'providers' => [
    ...
    Laravel\Scout\ScoutServiceProvider::class,
    ...
    TaxusSearch\LaravelScoutDriver\LaravelScoutDriverProvider::class,

],

Setting up Taxus configuration

At first, you should change your driver in config/scout.php file or in the environments:

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

You must have an api key and a search api key. visit Taxus.ir

If you need help with this please refer to the Taxus documentation

After you've published the Laravel Scout package configuration, you should publish taxus:

php artisan vendor:publish

After that, you can see taxus.php in the config folder

// config/taxus.php
    'key' => env('TAXUS_API_KEY', 'Taxus_API_KEY'),
    'search_key' => env('TAXUS_SEARCH_API_KEY', 'XXXXXXXXXXXXXXXX'),

Usage

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

Credits

taxus.ir

taxus-search / laravel-scout-driver

Maintainers

Details