{"id":17127419,"url":"https://github.com/tnir/instantsearch-singleindex-q","last_synced_at":"2025-03-24T03:45:41.075Z","repository":{"id":78341915,"uuid":"290966308","full_name":"tnir/instantsearch-singleindex-q","owner":"tnir","description":"@tnir/instantsearch.js, A JavaScript library for SEO- and user-friendly interface for Algolia InstantSearch.js","archived":false,"fork":false,"pushed_at":"2020-08-28T07:31:05.000Z","size":46943,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"q","last_synced_at":"2025-01-29T10:16:09.419Z","etag":null,"topics":["algolia-website","instantsearch"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@tnir/instantsearch.js","language":"TypeScript","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/tnir.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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}},"created_at":"2020-08-28T06:14:20.000Z","updated_at":"2020-09-11T17:09:34.000Z","dependencies_parsed_at":"2023-03-29T05:18:21.920Z","dependency_job_id":null,"html_url":"https://github.com/tnir/instantsearch-singleindex-q","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnir%2Finstantsearch-singleindex-q","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnir%2Finstantsearch-singleindex-q/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnir%2Finstantsearch-singleindex-q/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnir%2Finstantsearch-singleindex-q/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tnir","download_url":"https://codeload.github.com/tnir/instantsearch-singleindex-q/tar.gz/refs/heads/q","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245206532,"owners_count":20577582,"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":["algolia-website","instantsearch"],"created_at":"2024-10-14T19:04:37.589Z","updated_at":"2025-03-24T03:45:41.053Z","avatar_url":"https://github.com/tnir.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/\"\u003e\n    \u003cimg alt=\"InstantSearch.js\" src=\".github/banner.png\"\u003e\n  \u003c/a\u003e\n\n  \u003cp align=\"center\"\u003e\n    InstantSearch.js is a JavaScript library for building performant and instant search experiences with \u003ca href=\"https://www.algolia.com/?utm_source=instantsearch.js\u0026utm_campaign=repository\"\u003eAlgolia\u003c/a\u003e.\n  \u003c/p\u003e\n\u003c/p\u003e\n\n---\n\n[![Version][version-svg]][package-url]\n[![License][license-image]][license-url]\n[![Build Status][ci-svg]][ci-url]\n[![Pull reminders][pull-reminders-svg]][pull-reminders-url]\n\nInstantSearch.js is a vanilla JavaScript library that lets you create an instant-search result experience using [Algolia][algolia-website]’s search API. It is part of the InstantSearch family:\n\n**InstantSearch.js** | [React InstantSearch][react-instantsearch-github] | [Vue InstantSearch][vue-instantsearch-github] | [Angular InstantSearch][instantsearch-angular-github] | [React InstantSearch Native][react-instantsearch-github] | [InstantSearch Android][instantsearch-android-github] | [InstantSearch iOS][instantsearch-ios-github]\n\n\u003cdetails\u003e\n  \u003csummary\u003e\u003cstrong\u003eTable of contents\u003c/strong\u003e\u003c/summary\u003e\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n\n- [Why](#why)\n- [Getting started](#getting-started)\n- [Installation](#installation)\n- [Documentation](#documentation)\n- [Demos](#demos)\n- [Playground](#playground)\n- [Browser support](#browser-support)\n- [Troubleshooting](#troubleshooting)\n- [Contributing](#contributing)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n\u003c/details\u003e\n\n## Why\n\nYou should be using InstantSearch if you want to:\n\n- Design search experiences with best practices\n- Customize your components at will\n- Remain independent from external frameworks\n\n## Getting started\n\nUsing InstantSearch.js is as simple as adding this JavaScript code to your page:\n\n```javascript\n// 1. Instantiate the search\nconst search = instantsearch({\n  indexName: 'instant_search',\n  searchClient: algoliasearch('latency', '6be0576ff61c053d5f9a3225e2a90f76'),\n});\n\nsearch.addWidgets([\n  // 2. Create an interactive search box\n  instantsearch.widgets.searchBox({\n    container: '#searchbox',\n    placeholder: 'Search for products',\n  }),\n\n  // 3. Plug the search results into the product container\n  instantsearch.widgets.hits({\n    container: '#products',\n    templates: {\n      item: '{{#helpers.highlight}}{ \"attribute\": \"name\" }{{/helpers.highlight}}',\n    },\n  }),\n\n  // 4. Make the brands refinable\n  instantsearch.widgets.refinementList({\n    container: '#brand',\n    attribute: 'brand',\n  }),\n]);\n\n// 5. Start the search!\nsearch.start();\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://codesandbox.io/s/github/algolia/doc-code-samples/tree/master/InstantSearch.js/getting-started\" title=\"Edit on CodeSandbox\"\u003e\n    \u003cimg alt=\"Edit on CodeSandbox\" src=\"https://codesandbox.io/static/img/play-codesandbox.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nTo learn more about the library, follow the [getting started](https://www.algolia.com/doc/guides/building-search-ui/getting-started/js/) guide or check how to [add it to your own project](https://www.algolia.com/doc/guides/building-search-ui/installation/js/).\n\n## Installation\n\n```sh\nnpm install instantsearch.js algoliasearch\n# or\nyarn add instantsearch.js algoliasearch\n```\n\n## Documentation\n\nThe documentation is available on the [Algolia website](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/).\n\n## Demos\n\n| E-commerce                                                                                                                                                                                                                   | Media                                                                                                                                                                                                         | Travel                                                                                                                                                                                                              |\n| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| \u003ca href=\"https://instantsearchjs.netlify.com/examples/e-commerce/\"\u003e\u003cimg src=\"https://www.algolia.com/doc/assets/images/build-search-ui/demos/e-commerce-2c7ed6b6.png\" width=\"250\" alt=\"E-commerce demo preview\"\u003e\u003c/a\u003e | \u003ca href=\"https://instantsearchjs.netlify.com/examples/media/\"\u003e\u003cimg src=\"https://instantsearchjs.netlify.com/examples/media/capture.png\" width=\"250\" alt=\"Media demo preview\"\u003e\u003c/a\u003e | \u003ca href=\"https://instantsearchjs.netlify.com/examples/tourism/\"\u003e\u003cimg src=\"https://instantsearchjs.netlify.com/examples/tourism/capture.png\" width=\"250\" alt=\"Tourism demo preview\"\u003e\u003c/a\u003e |\n\nSee more demos [on the website](https://www.algolia.com/doc/guides/building-search-ui/resources/demos/js/).\n\n## Playground\n\nYou can get to know InstantSearch.js on [this playground](https://codesandbox.io/s/github/algolia/create-instantsearch-app/tree/templates/instantsearch.js).\n\nStart by [adding widgets](https://www.algolia.com/doc/guides/building-search-ui/widgets/showcase/js/) and tweaking the display. Once you feel familiar with the library, we recommend following the [getting started guide](https://www.algolia.com/doc/guides/building-search-ui/getting-started/js/).\n\n## Browser support\n\nWe support the **last two versions of major browsers** (Chrome, Edge, Firefox, Safari).\n\nPlease refer to the [browser support](https://www.algolia.com/doc/guides/building-search-ui/installation/js/#browser-support) section in the documentation to use InstantSearch.js on other browsers.\n\n## Troubleshooting\n\nEncountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/guides/building-search-ui/troubleshooting/faq/js/) where you will find answers for the most common issues and gotchas with the library.\n\n## Contributing\n\nWe welcome all contributors, from casual to regular 💙\n\n- **Bug report**. Is something not working as expected? [Send a bug report](https://github.com/algolia/instantsearch.js/issues/new?template=Bug_report.md).\n- **Feature request**. Would you like to add something to the library? [Send a feature request](https://github.com/algolia/instantsearch.js/issues/new?template=Feature_request.md).\n- **Documentation**. Did you find a typo in the doc? [Open an issue](https://github.com/algolia/instantsearch.js/issues/new) and we'll take care of it.\n- **Development**. If you don't know where to start, you can check the open issues that are [tagged easy](https://github.com/algolia/instantsearch.js/issues?q=is%3Aopen+is%3Aissue+label%3A%22Difficulty%3A++++++%E2%9D%84%EF%B8%8F+easy%22), the [bugs](https://github.com/algolia/instantsearch.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22%E2%9D%A4+Bug%22) or [chores](https://github.com/algolia/instantsearch.js/issues?q=is%3Aissue+is%3Aopen+label%3A%22%E2%9C%A8+Chore%22).\n\nTo start contributing to code, you need to:\n\n1.  [Fork the project](https://help.github.com/articles/fork-a-repo/)\n1.  [Clone the repository](https://help.github.com/articles/cloning-a-repository/)\n1.  Install the dependencies: `yarn`\n1.  Run the development mode: `yarn start`\n1.  [Open the stories](http://localhost:6006)\n\nPlease read [our contribution process](CONTRIBUTING.md) to learn more.\n\n## License\n\nInstantSearch.js is [MIT licensed][license-url].\n\n\u003c!-- Badges --\u003e\n\n[version-svg]: https://img.shields.io/npm/v/instantsearch.js.svg?style=flat-square\n[package-url]: https://npmjs.org/package/instantsearch.js\n[ci-svg]: https://img.shields.io/circleci/project/github/algolia/instantsearch.js.svg?style=flat-square\n[ci-url]: https://circleci.com/gh/algolia/instantsearch.js\n[pull-reminders-svg]: https://img.shields.io/badge/pull%20reminders-✓-success.svg?style=flat-square\n[pull-reminders-url]: https://pullreminders.com?ref=badge\n[license-image]: http://img.shields.io/badge/license-MIT-green.svg?style=flat-square\n[license-url]: LICENSE\n\n\u003c!-- Links --\u003e\n\n[algolia-website]: https://www.algolia.com/?utm_source=instantsearch.js\u0026utm_campaign=repository\n[react-instantsearch-github]: https://github.com/algolia/react-instantsearch/\n[vue-instantsearch-github]: https://github.com/algolia/vue-instantsearch\n[instantsearch-android-github]: https://github.com/algolia/instantsearch-android\n[instantsearch-ios-github]: https://github.com/algolia/instantsearch-ios\n[instantsearch-angular-github]: https://github.com/algolia/angular-instantsearch\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftnir%2Finstantsearch-singleindex-q","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftnir%2Finstantsearch-singleindex-q","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftnir%2Finstantsearch-singleindex-q/lists"}