{"id":20635729,"url":"https://github.com/nuxt-modules/algolia","last_synced_at":"2025-05-15T10:02:10.981Z","repository":{"id":36957437,"uuid":"444394127","full_name":"nuxt-modules/algolia","owner":"nuxt-modules","description":"🔎 Algolia module for Nuxt","archived":false,"fork":false,"pushed_at":"2025-05-06T17:47:43.000Z","size":2511,"stargazers_count":201,"open_issues_count":17,"forks_count":39,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-06T18:46:56.276Z","etag":null,"topics":["algolia","module","nuxt","search","vue"],"latest_commit_sha":null,"homepage":"https://algolia.nuxtjs.org/","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/nuxt-modules.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2022-01-04T11:30:00.000Z","updated_at":"2025-04-16T08:44:10.000Z","dependencies_parsed_at":"2023-01-17T08:15:31.642Z","dependency_job_id":"76723dd7-9e74-42ca-9456-a6364055e234","html_url":"https://github.com/nuxt-modules/algolia","commit_stats":{"total_commits":279,"total_committers":20,"mean_commits":13.95,"dds":0.4014336917562724,"last_synced_commit":"6a8f4f751084533e924f7161b6684438f9cd75b2"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Falgolia","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Falgolia/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Falgolia/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nuxt-modules%2Falgolia/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nuxt-modules","download_url":"https://codeload.github.com/nuxt-modules/algolia/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254319717,"owners_count":22051072,"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","module","nuxt","search","vue"],"created_at":"2024-11-16T15:06:57.327Z","updated_at":"2025-05-15T10:02:10.236Z","avatar_url":"https://github.com/nuxt-modules.png","language":"TypeScript","readme":"[![@nuxtjs/algolia](https://algolia.nuxtjs.org/preview.png)](https://algolia.nuxtjs.org)\n\n# @nuxtjs/algolia\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]\n[![Codecov][codecov-src]][codecov-href]\n[![License][license-src]][license-href]\n\n\u003e [Algolia](https://www.algolia.com/) module for [Nuxt](https://v3.nuxtjs.org)\n\n- [✨ \u0026nbsp;Release Notes](https://github.com/nuxt-modules/algolia/releases)\n- [📖 \u0026nbsp;Read the documentation](https://algolia.nuxtjs.org)\n\n## Features\n\n- Easy integration with Algolia\n- Handy composables like useAlgoliaSearch, useAsyncAlgoliaSearch\n- Support for Vue Instantsearch components\n- Support for Algolia Recommend\n- Support for Docsearch\n- Support for Automatic Indexing\n- Support for caching the requests and responses\n- Support for SSR requests\n\n[📖 \u0026nbsp;Read the documentation](https://algolia.nuxtjs.org)\n\n## Preview\n\n[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/github-epeint?file=app.vue)\n\n## Setup\n\n```sh\nnpx nuxi@latest module add algolia\n```\n\n## Basic usage\n\nAdd `ALGOLIA_API_KEY` and `ALGOLIA_APPLICATION_ID` environment variables to .env file.\n\n```env\nALGOLIA_API_KEY=\"0fd1c4eba2d831788333e77c9d855f1d\"\nALGOLIA_APPLICATION_ID=\"AGN9HEEKF3\"\n```\n\nNow you can start using `@nuxtjs/algolia` in your app!\n\nClient side:\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nconst { result, search } = useAlgoliaSearch('test_index')\n\nonMounted(async () =\u003e {\n  await search({ query: 'Samsung' })\n})\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e{{ result }}\u003c/div\u003e\n\u003c/template\u003e\n```\n\nOr SSR:\n\n```vue\n\u003cscript setup lang=\"ts\"\u003e\nconst { data } = await useAsyncAlgoliaSearch({ indexName: 'test_index', query: 'Samsung' })\n\u003c/script\u003e\n\n\u003ctemplate\u003e\n  \u003cdiv\u003e{{ data }}\u003c/div\u003e\n\u003c/template\u003e\n```\n\n## Development\n\n1. Clone this repository\n2. Install dependencies using `yarn install` or `npm install`\n3. Use `yarn dev:prepare` or `npm run dev:prepare` to prepare the development environment\n4. Start development server using `yarn dev` or `npm run dev`\n\n## License\n\n[MIT License](./LICENSE)\n\n\u003c!-- Badges --\u003e\n\n[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/algolia/latest.svg\n[npm-version-href]: https://npmjs.com/package/@nuxtjs/algolia\n[npm-downloads-src]: https://img.shields.io/npm/dt/@nuxtjs/algolia.svg\n[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/algolia\n[github-actions-ci-src]: https://github.com/nuxt-modules/algolia/actions/workflows/ci.yml/badge.svg\n[github-actions-ci-href]: https://github.com/nuxt-modules/algolia/actions?query=workflow%3Aci\n[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-modules/algolia.svg\n[codecov-href]: https://codecov.io/gh/nuxt-modules/algolia\n[license-src]: https://img.shields.io/npm/l/@nuxtjs/algolia.svg\n[license-href]: https://npmjs.com/package/@nuxtjs/algolia\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-modules%2Falgolia","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnuxt-modules%2Falgolia","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnuxt-modules%2Falgolia/lists"}