AdonisJS Magnify - Getting Started

Add @foadonis/magnify to AdonisJS, compose the Searchable mixin into a Lucid model, then connect Meilisearch, Typesense or Algolia in config/magnify.ts.

Installation

Install and configure the package using the following command :

node ace add @foadonis/magnify

Configure your Model

Magnify tries to be as easy as possible to configure. To accomplish that, it brings a Searchable mixin to make any Lucid model Searchable.

A Searchable model will be automatically synchronized with your Search engine.

app/models/post.ts

import {  } from '@adonisjs/core/helpers'
import { ,  } from '@adonisjs/lucid/orm'
import {  } from '@foadonis/magnify'

export default class  extends (, ) {
  @({ : true })
  declare : string

  @()
  declare : string
}