Skip to content

A demo of the NPM package Instantsearch-ItemsJS-adapter used to create a client side search functionality with an Instantsearch frontend.

Notifications You must be signed in to change notification settings

unplatform-io/clientside-instantsearch-demo

Repository files navigation

Client-side Instantsearch Demo

Instantsearch-ItemsJS-adapter

Introduction Instantsearch-ItemsJS-adapter

Instantsearch (build by Algolia) is an open-source, production-ready UI library that lets you quickly build a search interface in your front-end application. You can quickly perform searches on your website, in combination with an Algolia back-end (pay per search).

However, there are other options offering a suitable back-end solution. Definitely for a new business with a small catalog. For instance, with the Instantsearch-ItemsJS-adapter NPM-package. This package has a lot of features and can be easily implemented in your frond-end application. Another benefit is not having to think about the costs.

Furthermore, the use of a search service with a lot of functions is not necessary very often. Certainly not for an online store with a limited number of products. And if necessary, users can simply switch from this adapter to Algolia, because it supports the same front-end (Instantsearch).

This demo shows how Instantsearch can be used with ItemsJS using the Instantsearch-ItemsJS-adapter NPM-package. This package connects Instantsearch to ItemsJS and ItemsJS will perform a client-side based search for your website. Almost all features of Instantsearch are supported with this adapter. A List of features with extra information can be found in the adapter package readme.

Use application

Go to this link to see the demo in action. Demo

Run on localhost

After cloning this GitHub repository, run the following commands to start the application on your localhost.

npm install
npm run dev

Open http://localhost:3000 with your browser to see the result.

Contribute

Help to this project is appreciated. If you want to help please use Cypress and ESlint mentioned below, before creating a pull request.

To check the frond-end functionalities run Cypress tests, and if you make changes to the front-end also write some tests for this code.

npm run test

To keep the code clean run ESlint and resolve the errors when you're done programming.

npm run lint

To automaticly resolve the errors run:

npm run lint -- --fix

About

A demo of the NPM package Instantsearch-ItemsJS-adapter used to create a client side search functionality with an Instantsearch frontend.

Topics

Resources

Stars

Watchers

Forks