lee-to/moonshine-algolia-search

Algolia global search for MoonShine

1.0.0 2023-05-02 15:37 UTC

Requires

• php: ^8.0|^8.1|^8.2
• ext-curl: *
• ext-json: *
• algolia/algoliasearch-client-php: ^3.3

Requires (Dev)

• brianium/paratest: ^6.8
• mockery/mockery: ^1.4.4
• orchestra/testbench: ^4.0|^5.0|^6.0|^7.0|^8.0
• phpstan/phpstan: ^1.4.7
• phpunit/phpunit: ^9.5.8

Conflicts

• moonshine/moonshine: <1.55

MIT

• Danil Shutsky

• moonshine

README

Algolias search for MoonShine

As a result, all menu items will be indexed, including groups, resources, resource entries and custom pages

Installation

composer require lee-to/moonshine-algolia-search

Publish config

php artisan vendor:publish --provider="Leeto\MoonShineAlgoliaSearch\Providers\MoonShineAlgoliaSearchServiceProvider"

Register on the https://www.algolia.com, get the keys and set in config config/algolia.php

return [
    'app_id' => env('ALGOLIA_APP_ID'),
    'admin_key' => env('ALGOLIA_ADMIN_KEY'),
    'frontend_key' => env('ALGOLIA_FRONTEND_KEY'),
];

MoonShine config (app/moonshine.php)

// ...
'header' => 'algolia-search::global-search'
// ...

Create indexes

php artisan algolia-search:indexes

If you want to customize fields for models, implement the HasGlobalAlgoliaSearch interface

use Illuminate\Database\Eloquent\Model;
use Leeto\MoonShineAlgoliaSearch\Contracts\HasGlobalAlgoliaSearch;

class Post extends Model implements HasGlobalAlgoliaSearch
{
    public function globalSearch(): array
    {
        return [
            'description' => $this->text,
            'image' => $this->thumbnail
        ];
    }
}