README

This package allows you to easily integrate your project with Celi Search, adding a custom Laravel Scout provider.

This project is a work-in-progress. Code and documentation are currently under development and are subject to change.

Installation

You can install the package via composer:

composer require maize-tech/laravel-celi-search

You can publish the config file with:

php artisan vendor:publish --tag="celi-search-config"

This is the contents of the published config file:

return [

    /*
    |--------------------------------------------------------------------------
    | Base url
    |--------------------------------------------------------------------------
    |
    | Here you may specify the full base url used to perform update and destroy
    | requests to the Celi Search backoffice.
    |
    */

    'base_url' => env('CELI_BASE_URL'),

    /*
    |--------------------------------------------------------------------------
    | Search base url
    |--------------------------------------------------------------------------
    |
    | Here you may specify the full base url used to perform search queries.
    |
    */

    'search_base_url' => env('CELI_SEARCH_BASE_URL'),

    /*
    |--------------------------------------------------------------------------
    | Project name
    |--------------------------------------------------------------------------
    |
    | Here you may specify the name of the project defined in Celi Search.
    |
    */

    'project' => env('CELI_PROJECT'),

    /*
    |--------------------------------------------------------------------------
    | Searchable models
    |--------------------------------------------------------------------------
    |
    | Here you may specify the list of fully qualified class names of
    | searchable models.
    |
    */

    'searchables' => [
        // \App\Models\User::class,
    ],

];

Usage

$celiSearch = new Maize\CeliSearch();
echo $celiSearch->echoPhrase('Hello, Maize!');

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

maize-tech / laravel-celi-search

Maintainers

Details