Skip to content

Latest commit

 

History

History
 
 

jquery

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
css
css
 
 
img
img
 
 
js
js
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
data.json
data.json
 
 
index.html
index.html
 
 
instant-search.gif
instant-search.gif
 
 
package.json
package.json
 
 
push.rb
push.rb
 
 

README.md

Instant-Search Demo

This is a sample project implementing an instant-search based e-commerce website with Algolia. Algolia is a Search API that provides hosted full-text, numerical and faceted search.

Features

  • Full JavaScript (based on jQuery, Hogan.js and AlgoliaSearch + helper)
  • Results page refreshed as you type
  • Hits
  • Facets
  • Pagination
  • Relevant results from the first keystroke
  • Typo-tolerance
  • Multiple sort orders
  • By Relevance
  • By Highest Price
  • By Lowest Price
  • Backup search parameters in the URL

Usage

We've included some credentials in the code allowing you to test the demo without any Algolia account. If you want to replicate this demo using your own Algolia credentials, you can use the push.rb script to send the data and configure the indices.

./push.rb YourApplicationID YourAPIKey YourIndexName

Then, you'll need to replace the demo credentials with your own:

  • in js/app.js, set your own APPLICATION_ID instead of "latency" (which is our demo APPLICATION_ID),
  • in js/app.js, set your own SEARCH_ONLY_API_KEY instead of "6be0576ff61c053d5f9a3225e2a90f76",
  • in js/app.js, set your own index name instead of "instant_search".

Tutorial

Follow this step by step tutorial (on Algolia.com) to learn how this implementation works and how it has been built using the Algolia's Javascript API client and its helper.

Demo

Try out the demo Instant search

Data Set

We've extracted 10,000 products from the Best Buy Developer API. You can find the associated documentation here.

Run and develop locally

To hack and develop on this current repository:

git clone git@github.com:algolia/examples.git
cd instant-search/jquery
npm install
npm run dev