{"id":13721592,"url":"https://github.com/meilisearch/meilisearch-vue","last_synced_at":"2025-05-07T13:33:24.539Z","repository":{"id":39862990,"uuid":"277852835","full_name":"meilisearch/meilisearch-vue","owner":"meilisearch","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-20T13:19:23.000Z","size":15905,"stargazers_count":153,"open_issues_count":4,"forks_count":13,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-08-04T01:15:23.386Z","etag":null,"topics":["client","instantsearch","meilisearch","vue"],"latest_commit_sha":null,"homepage":"https://www.meilisearch.com/","language":null,"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/meilisearch.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}},"created_at":"2020-07-07T15:22:41.000Z","updated_at":"2024-07-17T18:58:06.000Z","dependencies_parsed_at":"2024-03-20T14:04:07.662Z","dependency_job_id":null,"html_url":"https://github.com/meilisearch/meilisearch-vue","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/meilisearch%2Fmeilisearch-vue","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fmeilisearch-vue/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fmeilisearch-vue/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fmeilisearch-vue/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meilisearch","download_url":"https://codeload.github.com/meilisearch/meilisearch-vue/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224605058,"owners_count":17339253,"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":["client","instantsearch","meilisearch","vue"],"created_at":"2024-08-03T01:01:18.988Z","updated_at":"2024-11-14T10:31:47.167Z","avatar_url":"https://github.com/meilisearch.png","language":null,"funding_links":[],"categories":["Integrations","Others"],"sub_categories":["Official Integrations"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/meilisearch/integration-guides/main/assets/logos/meilisearch_vuejs.svg\" alt=\"Meilisearch-Vue\" width=\"200\" height=\"200\" /\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eMeilisearch Vue\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/meilisearch/meilisearch\"\u003eMeilisearch\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/cloud?utm_campaign=oss\u0026utm_source=github\u0026utm_medium=meilisearch-vue\"\u003eMeilisearch Cloud\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/docs\"\u003eDocumentation\u003c/a\u003e |\n  \u003ca href=\"https://discord.meilisearch.com\"\u003eDiscord\u003c/a\u003e |\n  \u003ca href=\"https://roadmap.meilisearch.com/tabs/1-under-consideration\"\u003eRoadmap\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com\"\u003eWebsite\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/docs/faq\"\u003eFAQ\u003c/a\u003e\n\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/meilisearch/meilisearch-vue/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-informational\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e⚡ How to integrate a front-end search bar in your Vue application using Meilisearch\u003c/p\u003e\n\n**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch)\n\nThis repository describes the steps to integrate a relevant front-end search bar with a search-as-you-type experience!\n\n\n## Table of Contents \u003c!-- omit in toc --\u003e\n\n- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)\n- [🔧 Installation](#-installation)\n- [🤘 Getting Started Vue 2](#-getting-started-vue-2)\n- [🤟 Getting Started Vue 3](#-getting-started-vue-3)\n- [👩‍🎨 Examples](#-examples)\n- [💅 Customization and Documentation](#-customization-and-documentation)\n\n## ⚡ Supercharge your Meilisearch experience\n\nSay goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss\u0026utm_source=github\u0026utm_medium=meilisearch-ruby). Get started with a 14-day free trial! No credit card required.\n\n## 🔧 Installation\n\nTo integrate a front-end search bar, you need to install two packages:\n- the open-source [Vue InstantSearch](https://github.com/algolia/vue-instantsearch/) library powered by Algolia that provides all the front-end tools you need to highly customize your search bar environment.\n- the Meilisearch client [instant-meilisearch](https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch) to establish the communication between your Meilisearch instance and the Vue InstantSearch library.\u003cbr\u003e\n_Instead of reinventing the wheel, we have opted to reuse the InstantSearch library for our own front-end tooling. We will contribute upstream any improvements that may result from our adoption of InstantSearch._\n\nRun:\n\n```bash\nyarn add vue-instantsearch @meilisearch/instant-meilisearch instantsearch.css\n# or\nnpm install vue-instantsearch @meilisearch/instant-meilisearch instantsearch.css\n```\n\nNB: If you don't have any Meilisearch instance running and containing your data, you should take a look at this [getting started page](https://www.meilisearch.com/docs/learn/getting_started/installation#installation).\n\n## 🤘 Getting Started Vue 2\n\nThe following getting started uses `Vue 2`. A `Vue 2` example is [provided here](#-examples).\n\nIn the `main.js` file:\n\n```js\nimport Vue from 'vue';\nimport App from './App.vue';\nimport InstantSearch from 'vue-instantsearch';\n\nVue.use(InstantSearch);\n\nnew Vue({\n  el: '#app',\n  render: h =\u003e h(App),\n});\n```\n\nIn the `App.vue` file:\n\n```vue\n\u003ctemplate\u003e\n  \u003cais-instant-search :search-client=\"searchClient\" index-name=\"steam-video-games\"\u003e\n    \u003cais-search-box /\u003e\n    \u003cais-hits\u003e\n      \u003cdiv slot=\"item\" slot-scope=\"{ item }\"\u003e\n        \u003ch2\u003e{{ item.name }}\u003c/h2\u003e\n      \u003c/div\u003e\n    \u003c/ais-hits\u003e\n  \u003c/ais-instant-search\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\nimport { instantMeiliSearch } from '@meilisearch/instant-meilisearch';\n\nexport default {\n  data() {\n    return {\n      searchClient: instantMeiliSearch(\n        \"https://ms-adf78ae33284-106.lon.meilisearch.io\",\n        \"a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303\",\n      ),\n    };\n  },\n};\n\u003c/script\u003e\n\n\u003cstyle\u003e\nbody {\n  font-family: sans-serif;\n  padding: 1em;\n}\n\u003c/style\u003e\n```\n\n## 🤟 Getting Started Vue 3\n\nThe following getting started uses `Vue 3`. A `Vue 3` example is [provided here](#-examples).\n\nIn the `main.js` file:\n\n```js\nimport { createApp } from 'vue'\nimport App from './App.vue'\nimport InstantSearch from 'vue-instantsearch/vue3/es';\n\ncreateApp(App)\n    .use(InstantSearch)\n    .mount('#app')\n```\n\nIn the `App.vue` file:\n\n```vue\n\u003ctemplate\u003e\n  \u003cais-instant-search\n    :search-client=\"searchClient\"\n    index-name=\"steam-video-games\"\n  \u003e\n    \u003cais-search-box /\u003e\n    \u003cais-hits\u003e\n      \u003ctemplate v-slot:item=\"{ item }\"\u003e\n        \u003cais-highlight :hit=\"item\" attribute=\"name\" /\u003e\n      \u003c/template\u003e\n    \u003c/ais-hits\u003e\n  \u003c/ais-instant-search\u003e\n\u003c/template\u003e\n\n\u003cscript\u003e\nimport { instantMeiliSearch } from \"@meilisearch/instant-meilisearch\";\nimport \"instantsearch.css/themes/algolia-min.css\";\n\n\nexport default {\n  data() {\n    return {\n      searchClient: instantMeiliSearch(\n        \"https://ms-adf78ae33284-106.lon.meilisearch.io\",\n        \"a63da4928426f12639e19d62886f621130f3fa9ff3c7534c5d179f0f51c4f303\",\n      ).searchClient,\n    };\n  },\n};\n\u003c/script\u003e\n```\n\n## 👩‍🎨 Examples\n\n🚀 For a full example, please take a look at this CodeSandbox:\n\nFor Vue 2 \u003cbr\u003e\n\n[![Edit MS + Vue2-IS](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/ms-vue-is-1d6bi?fontsize=14\u0026hidenavigation=1\u0026theme=dark)\n\nFor Vue 3 \u003cbr\u003e\n\n[![Edit MS + Vue3-IS](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/p/sandbox/ms-vue3-is-forked-wsrkl8)\n\n💡 If you have never used Vue InstantSearch before, we recommend reading this [getting started documentation](https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/vue/).\n\n## 💅 Customization and Documentation\n\n- The open-source Vue InstantSearch library is widely used and well documented in the [Algolia documentation](https://www.algolia.com/doc/api-reference/widgets/vue/). It provides all the widgets to customize and improve your search bar environment in your Vue application.\n- The [instant-meilisearch documentation](https://github.com/meilisearch/meilisearch-js-plugins/tree/main/packages/instant-meilisearch) to add some customization.\n- The [Meilisearch documentation](https://www.meilisearch.com/docs/).\n\n\u003chr\u003e\n\n**Meilisearch** provides and maintains many **SDKs and Integration tools** like this one. We want to provide everyone with an **amazing search experience for any kind of project**. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the [integration-guides](https://github.com/meilisearch/integration-guides) repository.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeilisearch%2Fmeilisearch-vue","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeilisearch%2Fmeilisearch-vue","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeilisearch%2Fmeilisearch-vue/lists"}