vercel / algolite

An Implementation of Algolia to emulate its REST API

Home Page:https://www.npmjs.com/package/algolite

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Algolite

An Implementation of Algolia to emulate its REST API on your local machine or CI environments in order to speed up your development and testing cycles.

Installation

npm run -g algolite

Example

$ algolite --help

Usage: algolite [--port <port>] [--path <path>]

An Algolia REST API Implementation

Options:
--help                Display this help message and exit
--port <port>         The port to listen on (default: 9200)
--path <path>         The path to use for the LevelDB store (Your project folder)

Once running any algolia client can be used.

const client = algoliasearch('app-id', 'api-key', {
  hosts: [{
    protocol: 'http',
    url: 'localhost:9200'
  }]
})

const index = client.initIndex('entries');

await index.addObject({
  title: 'Algolia 2019',
  contentType: 'events'
})

const result = await index.search('Algolia')

Docker Image

docker run --rm -p 9200:9200 --name algolite marconi1992/algolite:0.1.1

About

An Implementation of Algolia to emulate its REST API

https://www.npmjs.com/package/algolite


Languages

Language:JavaScript 84.9%Language:PEG.js 14.3%Language:Dockerfile 0.8%