Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 1.64 KB

README.md

File metadata and controls

61 lines (39 loc) · 1.64 KB

Introduction

Larasearch is a Laravel package that aims to seamlessly integrate Elasticsearch functionality with the Eloquent ORM.

Features

  • Plug 'n Play searching functionality for Eloquent models
  • Automatic creation/indexing based on Eloquent model properties and relations
  • Aggregations, Suggestions, Autocomplete, Highlighting, etc. It's all there!
  • Load Eloquent models based on Elasticsearch queries
  • Automatic reindexing on updates of (related) Eloquent models

Installation

Laravel 5

NB: This is preliminary support. When L5 compatibility is stable I will tag it with a version.

Add Larasearch to your composer.json file:

"iverberk/larasearch": "dev-L5"

Add the service provider to your Laravel application config:

'Iverberk\Larasearch\LarasearchServiceProvider'

Laravel 4

Add Larasearch to your composer.json file:

"iverberk/larasearch": "0.8.0"

Add the service provider to your Laravel application config:

'Iverberk\Larasearch\LarasearchServiceProvider'

Wiki

Please see the Github wiki for the most up-to-date documentation.

Changelog

All releases are tracked and documented in the changelog.

Credits

This package is very much inspired by these excellent packages that already exist for the Ruby/Rails ecosystem.

A lot of their ideas have been reused to work within a PHP/Laravel environment.