{"id":18711739,"url":"https://github.com/algolia/instant-search-demo","last_synced_at":"2025-06-19T15:42:28.834Z","repository":{"id":18288760,"uuid":"21459391","full_name":"algolia/instant-search-demo","owner":"algolia","description":"Instant-search demo (facets, sliders, paginations \u0026 more)","archived":false,"fork":false,"pushed_at":"2025-05-30T08:28:20.000Z","size":29136,"stargazers_count":144,"open_issues_count":23,"forks_count":91,"subscribers_count":77,"default_branch":"master","last_synced_at":"2025-05-30T10:56:43.922Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://preview.algolia.com/instantsearch","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/algolia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2014-07-03T10:56:37.000Z","updated_at":"2025-03-04T15:01:53.000Z","dependencies_parsed_at":"2023-10-14T23:06:27.507Z","dependency_job_id":"c58c857b-ec15-40c5-9cec-f4a830de549c","html_url":"https://github.com/algolia/instant-search-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/algolia/instant-search-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Finstant-search-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Finstant-search-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Finstant-search-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Finstant-search-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algolia","download_url":"https://codeload.github.com/algolia/instant-search-demo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algolia%2Finstant-search-demo/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260781486,"owners_count":23062245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-07T12:40:38.353Z","updated_at":"2025-06-19T15:42:23.820Z","avatar_url":"https://github.com/algolia.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"**Note:** this repository is hosting the demo that was previously located at [algolia/examples](https://github.com/algolia/examples/tree/master/instant-search/instantsearch.js/)\n\n-----\n\nInstant-Search Demo\n====================\n\nThis is a sample project of an [Algolia](http://www.algolia.com) Instant-Search result page on an e-commerce website. Algolia is a Search API that provides a hosted full-text, numerical and faceted search.\n\n## Demos\nTry out the [demo](https://preview.algolia.com/instantsearch/)\n![Instant search](screenshots/instant-search-default.gif)\n\n### Simplified version\nThis project also includes a simplified version of the implementation that includes a few less filtering options.\nThe code is available in the files `index-simplified.html` and `search-simplified.js`. You can [see it live here](https://preview.algolia.com/instantsearch/index-simplified.html).\n\n## Features\n* Full-JavaScript/frontend implementation based on [instantsearch.js](https://community.algolia.com/instantsearch.js/)\n* Results page refreshed as you type\n* Relevant results from the first keystroke\n* Rich set of filters\n  * Multi-level categories\n  * Range slider\n  * Star rating\n* Typo-tolerance\n* Multiple sort orders\n  * By Relevance\n  * By Highest Price\n  * By Lowest Price\n* Backup search parameters in the URL\n\n## Run and develop locally\n\nFirst, [install nvm](https://github.com/creationix/nvm#installation), then run:\n\n```sh\ngit clone git@github.com:algolia/instant-search-demo.git\ncd instant-search-demo\nnvm use\nnpm install\nnpm start\nopen http://localhost:3000\n```\n\nWe've included some credentials in the code allowing you to test the demo without any Algolia account.\n\n### Data import\nIf you want to replicate this demo using your own Algolia credentials that you can obtain creating a free account on Algolia.com.\n\nJust install the Ruby `algoliasearch` gem and use the `push.rb` script to send the data and automatically configure the product index (same for both versions).\n\n```sh\n$ gem install algoliasearch\n$ ./dataset_import/push.rb YourApplicationID YourAdminAPIKey YourIndexName\n```\n\nThen, you'll need to replace the demo credentials with your own:\n- in `search.js` and `search-simplified.js`, set your own `APPLICATION_ID` instead of `\"latency\"` (which is our demo `APPLICATION_ID`),\n- in `search.js` and `search-simplified.js`, set your own `SEARCH_ONLY_API_KEY` instead of `\"6be0576ff61c053d5f9a3225e2a90f76\"`,\n- in `search.js` and `search-simplified.js`, set your own `index` name instead of `\"instant_search\"`.\n\n\nWe've extracted 20 000+ products from the [Best Buy Developer API](https://developer.bestbuy.com). You can find the associated documentation [here](https://developer.bestbuy.com/documentation/products-api).\n\n## Tutorial\n\n**Follow this [step by step tutorial](https://www.algolia.com/doc/tutorials/search-ui/instant-search/build-an-instant-search-results-page/instantsearchjs/) (on Algolia.com) to learn how this implementation works** and how it has been built using the [instantsearch.js library](https://community.algolia.com/instantsearch.js/).\n\nA more general overview of filtering and faceting is available in a [dedicated tutorial](https://www.algolia.com/doc/tutorials/search-ui/instant-search/filtering/faceting-search-ui/instantsearchjs/).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Finstant-search-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgolia%2Finstant-search-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgolia%2Finstant-search-demo/lists"}