https://github.com/maize-tech/laravel-celi-search
Integrate Celi Search engine as a Laravel Scout custom provider
https://github.com/maize-tech/laravel-celi-search
celi-search laravel laravel-scout scout search-engine
Last synced: 8 months ago
JSON representation
Integrate Celi Search engine as a Laravel Scout custom provider
- Host: GitHub
- URL: https://github.com/maize-tech/laravel-celi-search
- Owner: maize-tech
- License: mit
- Created: 2022-10-26T15:52:56.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-08T09:56:51.000Z (almost 2 years ago)
- Last Synced: 2025-07-27T10:10:19.224Z (11 months ago)
- Topics: celi-search, laravel, laravel-scout, scout, search-engine
- Language: PHP
- Homepage:
- Size: 47.9 KB
- Stars: 4
- Watchers: 5
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Celi Search
[](https://packagist.org/packages/maize-tech/laravel-celi-search)
[](https://github.com/maize-tech/laravel-celi-search/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://github.com/maize-tech/laravel-celi-search/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
[](https://packagist.org/packages/maize-tech/laravel-celi-search)
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:
```bash
composer require maize-tech/laravel-celi-search
```
You can publish the config file with:
```bash
php artisan vendor:publish --tag="celi-search-config"
```
This is the contents of the published config file:
```php
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
```php
$celiSearch = new Maize\CeliSearch();
echo $celiSearch->echoPhrase('Hello, Maize!');
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/maize-tech/.github/blob/main/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](https://github.com/maize-tech/.github/security/policy) on how to report security vulnerabilities.
## Credits
- [Enrico De Lazzari](https://github.com/enricodelazzari)
- [Riccardo Dalla Via](https://github.com/riccardodallavia)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.