{"id":13721805,"url":"https://github.com/xlanex6/nuxt-meilisearch","last_synced_at":"2025-04-06T02:09:50.089Z","repository":{"id":39583024,"uuid":"489500112","full_name":"xlanex6/nuxt-meilisearch","owner":"xlanex6","description":"🔎 Meilisearch module for Nuxt 3","archived":false,"fork":false,"pushed_at":"2024-08-20T07:11:36.000Z","size":2730,"stargazers_count":121,"open_issues_count":6,"forks_count":17,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T15:34:26.024Z","etag":null,"topics":["meilisearch","meilisearch-nuxt","nuxt","nuxt-module","nuxt3","nuxtjs"],"latest_commit_sha":null,"homepage":"https://nuxt-meilisearch.vercel.app","language":"Vue","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/xlanex6.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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}},"created_at":"2022-05-06T21:38:12.000Z","updated_at":"2025-01-02T07:34:04.000Z","dependencies_parsed_at":"2023-02-15T19:01:12.459Z","dependency_job_id":"305e4bd0-9a6a-4dc5-8adc-d1d9b4e24ddc","html_url":"https://github.com/xlanex6/nuxt-meilisearch","commit_stats":{"total_commits":58,"total_committers":3,"mean_commits":"19.333333333333332","dds":0.03448275862068961,"last_synced_commit":"d0b617f81f714e30445e653a5bf98648b1f4650b"},"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlanex6%2Fnuxt-meilisearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlanex6%2Fnuxt-meilisearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlanex6%2Fnuxt-meilisearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlanex6%2Fnuxt-meilisearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xlanex6","download_url":"https://codeload.github.com/xlanex6/nuxt-meilisearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247423515,"owners_count":20936626,"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":["meilisearch","meilisearch-nuxt","nuxt","nuxt-module","nuxt3","nuxtjs"],"created_at":"2024-08-03T01:01:21.625Z","updated_at":"2025-04-06T02:09:50.074Z","avatar_url":"https://github.com/xlanex6.png","language":"Vue","funding_links":[],"categories":["Vue","Integrations"],"sub_categories":["Community Integrations"],"readme":"[![xlanex6/nuxt-meilisearch](./docus/public/cover.png)](https://nuxt-meilisearch.vercel.app/)\n\n\u003cp align='center'\u003e\n\n[![Latest Stable Version](https://img.shields.io/npm/v/nuxt-meilisearch.svg?style=for-the-badge)](https://www.npmjs.com/package/nuxt-meilisearch) [![License](https://img.shields.io/npm/l/nuxt-meilisearch.svg?style=for-the-badge)](https://www.npmjs.com/package/nuxt-meilisearch)\n[![Twitter Follow](https://img.shields.io/twitter/follow/xlanex6?color=1DA1F2\u0026logo=twitter\u0026style=for-the-badge)](https://twitter.com/xlanex6)\n\n\u003c/p\u003e\n\n# Nuxt Meilisearch\n\nIntegrate [Meilisearch](https://meilisearch.com/?utm_campaign=oss\u0026utm_source=github\u0026utm_content=nuxt-meilisearch) fast and hyper-relevant search engine in your [Nuxt](https://nuxt.com) application.\n\nRead [Nuxt Meilisearch documentation](https://nuxt-meilisearch.vercel.app).\n\n## Features\n\n- Nuxt 3 integration\n- Auto-imported composables\n- Server-side rendering support\n- Client \u0026 server integration of Meilisearch\n- Full TypeScript support\n- Compatible with [Instant Meilisearch](https://github.com/meilisearch/instant-meilisearch)\n- Vue [Algolia InstantSearch](https://github.com/algolia/instantsearch) components (optional)\n\n## Installation\n\nAdd `nuxt-meilisearch` using the Nuxt CLI to your project\n\n```bash\nnpx nuxi@latest module add nuxt-meilisearch\n```\n\nor add `nuxt-meilisearch` using your dependency manager\n\n```bash\n# with npm\nnpm install nuxt-meilisearch\n\n# with yarn\nyarn add nuxt-meilisearch\n\n# with pnpm\npnpm add nuxt-meilisearch\n```\n\nand then to the `modules` section of `nuxt.config.ts`:\n\n ```ts\n// nuxt.config.ts\nexport default defineNuxtConfig({\n  modules: [\n    'nuxt-meilisearch'\n  ],\n  meilisearch: {\n    hostUrl:  '\u003cyour_meilisearch_host\u003e', //required\n    searchApiKey: '\u003cpublic_search_api_key\u003e', // required\n    adminApiKey: '\u003cadmin_api_key\u003e', // optional\n    serverSideUsage: true // default: false\n})\n```\n\nThat's it! 🎉\n\n## Usage\n\nThis example performs a search in the `books` index:\n\n```html\n\u003cscript setup\u003e\nconst { search, result } = useMeiliSearch('books')\n\nonMounted(async () =\u003e {\n  await search('harry');\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e\n    {{ result }}\n  \u003c/div\u003e\n\u003c/template\u003e\n```\n\nLearn more in the [Nuxt Meilisearch documentation](https://nuxt-meilisearch.vercel.app).\n\n## Contributing\n\nIssues and pull requests are welcome. 🫶\n\n**Local development**\n\n- Run `npm run dev:prepare` to generate type stubs.\n- Use `npm run dev` to start [playground](./playground) in development mode.\n\n## Licence\n\n[MIT Licence](./LICENCE)\n\n\u003c!-- Badges --\u003e\n\n\u003c!-- [npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/partytown/latest.svg\n[npm-version-href]: https://npmjs.com/package/@nuxtjs/partytown\n[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/partytown.svg\n[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/partytown\n[github-actions-ci-src]: https://github.com/nuxt-community/partytown-module/workflows/ci/badge.svg\n[github-actions-ci-href]: https://github.com/nuxt-community/partytown-module/actions?query=workflow%3Aci\n[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/partytown-module.svg\n[codecov-href]: https://codecov.io/gh/nuxt-community/partytown-module\n[license-src]: https://img.shields.io/npm/l/@nuxtjs/partytown.svg\n[license-href]: https://npmjs.com/package/@nuxtjs/partytown --\u003e\n\n\u003c!--\nFor Meilisearch DEmo\nexemple valid MASTER_KEY\n`PZKj1rFXYBnjLzEIxXRRaEz3gNDWTG3JoW6ZDzd6-mo`\n\n```bash\ndocker run -it --rm \\\n  -p 7700:7700 \\\n  -e MEILI_MASTER_KEY='PZKj1rFXYBnjLzEIxXRRaEz3gNDWTG3JoW6ZDzd6-mo'\\\n  -v $(pwd)/meili_data:/meili_data \\\n  getmeili/meilisearch:v1.5\n``` --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlanex6%2Fnuxt-meilisearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxlanex6%2Fnuxt-meilisearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlanex6%2Fnuxt-meilisearch/lists"}