Algolia

Algolia is a closed-source, lightning-fast search engine for apps and websites. It delivers smart, instant results and offers a free plan to get started.

Getting Started

Install dependencies

First install the algoliasearch package.

npm install algoliasearch

Head over your Algolia Application and grab your Application Id and the Write API Key.

Configure environment variables

Update your environment variables schema and add them to your .env file.

import { Env } from '@adonisjs/core/env'
 
export default await Env.create(new URL('../', import.meta.url), {
  ALGOLIA_APP_ID: Env.schema.string(),
  ALGOLIA_API_KEY: Env.schema.string(),
})

Configure the Search Engine

Add the AlgoliaEngine to your Magnify configuration.

config/magnify.ts

import env from '#start/env'
import { defineConfig, engines } from '@foadonis/magnify'
import type { InferEngines } from '@foadonis/magnify/types'
 
const magnifyConfig = defineConfig({
  default: 'algolia',
  engines: {
    algolia: engines.algolia({
      appId: env.get('ALGOLIA_APP_ID'),
      apiKey: env.get('ALGOLIA_API_KEY'),
    }),
  },
})
 
export default magnifyConfig
 
/**
 * Inferring types for the list of engines you have configured
 * in your application.
 */
declare module '@foadonis/magnify/types' {
  export interface EnginesList extends InferEngines<typeof magnifyConfig> {}
}

Getting Started

Install dependencies

Configure environment variables

Configure the Search Engine

Start Searching

On this page