{"_path":"/getting-started/quick-start","_draft":false,"_partial":false,"_empty":false,"title":"Quick start","description":"","excerpt":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"setup"},"children":[{"type":"text","value":"Setup"}]},{"type":"element","tag":"ol","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Install Algolia module"}]}]}]},{"type":"element","tag":"code","props":{"code":"npx nuxi@latest module add algolia\n","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"npx nuxi@latest module add algolia\n"}]}]}]},{"type":"element","tag":"ol","props":{"start":2},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Add "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"ALGOLIA_API_KEY"}]},{"type":"text","value":" and "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/account/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"ALGOLIA_APPLICATION_ID"}]},{"type":"text","value":" to the .env"}]}]}]},{"type":"element","tag":"code","props":{"code":"ALGOLIA_API_KEY=\"0fd1c4eba2d831788333e77c9d855f1d\"\nALGOLIA_APPLICATION_ID=\"AGN9HEEKF3\"\n","language":"env"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"ALGOLIA_API_KEY=\"0fd1c4eba2d831788333e77c9d855f1d\"\nALGOLIA_APPLICATION_ID=\"AGN9HEEKF3\"\n"}]}]}]},{"type":"element","tag":"ol","props":{"start":3},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Use Algolia in your application"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Client side:"}]},{"type":"element","tag":"code","props":{"code":"<script setup lang=\"ts\">\nconst { result, search } = useAlgoliaSearch('test_index')\n\nonMounted(async () => {\n  await search({ query: 'Samsung' })\n})\n</script>\n\n<template>\n  <div>{{ result }}</div>\n</template>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<script setup lang=\"ts\">\nconst { result, search } = useAlgoliaSearch('test_index')\n\nonMounted(async () => {\n  await search({ query: 'Samsung' })\n})\n</script>\n\n<template>\n  <div>{{ result }}</div>\n</template>\n"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Or SSR:"}]},{"type":"element","tag":"code","props":{"code":"<script setup lang=\"ts\">\nconst { data } = await useAsyncAlgoliaSearch({ indexName: 'test_index', query: 'Samsung' })\n</script>\n\n<template>\n  <div>{{ data }}</div>\n</template>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"text","value":"<script setup lang=\"ts\">\nconst { data } = await useAsyncAlgoliaSearch({ indexName: 'test_index', query: 'Samsung' })\n</script>\n\n<template>\n  <div>{{ data }}</div>\n</template>\n"}]}]}]},{"type":"element","tag":"alert","props":{"type":"success"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"That's it! You can now use Algolia in your Nuxt app ✨"}]}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Check out "},{"type":"element","tag":"a","props":{"href":"/getting-started/usage","class":"text-primary-500"},"children":[{"type":"text","value":"how to use Algolia module further"}]},{"type":"text","value":"."}]}]}]},"body":{"type":"root","children":[{"type":"element","tag":"h2","props":{"id":"setup"},"children":[{"type":"text","value":"Setup"}]},{"type":"element","tag":"ol","props":{},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Install Algolia module"}]}]}]},{"type":"element","tag":"code","props":{"code":"npx nuxi@latest module add algolia\n","language":"bash"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"npx nuxi@latest module add algolia"}]}]}]}]}]},{"type":"element","tag":"ol","props":{"start":2},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Add "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/doc/guides/security/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"ALGOLIA_API_KEY"}]},{"type":"text","value":" and "},{"type":"element","tag":"a","props":{"href":"https://www.algolia.com/account/api-keys/","rel":["nofollow","noopener","noreferrer"],"target":"_blank"},"children":[{"type":"text","value":"ALGOLIA_APPLICATION_ID"}]},{"type":"text","value":" to the .env"}]}]}]},{"type":"element","tag":"code","props":{"code":"ALGOLIA_API_KEY=\"0fd1c4eba2d831788333e77c9d855f1d\"\nALGOLIA_APPLICATION_ID=\"AGN9HEEKF3\"\n","language":"env"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{},"children":[{"type":"text","value":"ALGOLIA_API_KEY=\"0fd1c4eba2d831788333e77c9d855f1d\"\nALGOLIA_APPLICATION_ID=\"AGN9HEEKF3\""}]}]}]}]}]},{"type":"element","tag":"ol","props":{"start":3},"children":[{"type":"element","tag":"li","props":{},"children":[{"type":"element","tag":"strong","props":{},"children":[{"type":"text","value":"Use Algolia in your application"}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Client side:"}]},{"type":"element","tag":"code","props":{"code":"<script setup lang=\"ts\">\nconst { result, search } = useAlgoliaSearch('test_index')\n\nonMounted(async () => {\n  await search({ query: 'Samsung' })\n})\n</script>\n\n<template>\n  <div>{{ result }}</div>\n</template>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-e760b1"},"children":[{"type":"text","value":"\"ts\""}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-bbf2d8"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-639e92"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-639e92"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-49e461"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-7fe924"},"children":[{"type":"text","value":"useAlgoliaSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-e760b1"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":")"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-7fe924"},"children":[{"type":"text","value":"onMounted"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"("}]},{"type":"element","tag":"span","props":{"class":"ct-bbf2d8"},"children":[{"type":"text","value":"async"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" () "}]},{"type":"element","tag":"span","props":{"class":"ct-bbf2d8"},"children":[{"type":"text","value":"=>"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" {"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"  "}]},{"type":"element","tag":"span","props":{"class":"ct-bbf2d8"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-7fe924"},"children":[{"type":"text","value":"search"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-e760b1"},"children":[{"type":"text","value":"'Samsung'"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" })"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"})"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"  <"}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">{{ "}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"result"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" }}</"}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]}]}]}]},{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Or SSR:"}]},{"type":"element","tag":"code","props":{"code":"<script setup lang=\"ts\">\nconst { data } = await useAsyncAlgoliaSearch({ indexName: 'test_index', query: 'Samsung' })\n</script>\n\n<template>\n  <div>{{ data }}</div>\n</template>\n","language":"vue"},"children":[{"type":"element","tag":"pre","props":{},"children":[{"type":"element","tag":"code","props":{"__ignoreMap":""},"children":[{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"setup"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"lang"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-e760b1"},"children":[{"type":"text","value":"\"ts\""}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-bbf2d8"},"children":[{"type":"text","value":"const"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" { "}]},{"type":"element","tag":"span","props":{"class":"ct-639e92"},"children":[{"type":"text","value":"data"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" } "}]},{"type":"element","tag":"span","props":{"class":"ct-49e461"},"children":[{"type":"text","value":"="}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-bbf2d8"},"children":[{"type":"text","value":"await"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" "}]},{"type":"element","tag":"span","props":{"class":"ct-7fe924"},"children":[{"type":"text","value":"useAsyncAlgoliaSearch"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"({ "}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"indexName"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-e760b1"},"children":[{"type":"text","value":"'test_index'"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":", "}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"query"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":": "}]},{"type":"element","tag":"span","props":{"class":"ct-e760b1"},"children":[{"type":"text","value":"'Samsung'"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" })"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"script"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"<"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"  <"}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">{{ "}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"data"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":" }}</"}]},{"type":"element","tag":"span","props":{"class":"ct-2f6ba0"},"children":[{"type":"text","value":"div"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]},{"type":"element","tag":"span","props":{"class":"line"},"children":[{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":"</"}]},{"type":"element","tag":"span","props":{"class":"ct-43d561"},"children":[{"type":"text","value":"template"}]},{"type":"element","tag":"span","props":{"class":"ct-704be1"},"children":[{"type":"text","value":">"}]}]}]}]}]},{"type":"element","tag":"alert","props":{"type":"success"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"That's it! You can now use Algolia in your Nuxt app ✨"}]}]},{"type":"element","tag":"alert","props":{"type":"info"},"children":[{"type":"element","tag":"p","props":{},"children":[{"type":"text","value":"Check out "},{"type":"element","tag":"a","props":{"href":"/getting-started/usage","class":"text-primary-500"},"children":[{"type":"text","value":"how to use Algolia module further"}]},{"type":"text","value":"."}]}]},{"type":"element","tag":"style","children":[{"type":"text","value":".ct-7fe924{color:#61AFEF}.ct-49e461{color:#56B6C2}.ct-639e92{color:#E5C07B}.ct-bbf2d8{color:#C678DD}.ct-e760b1{color:#98C379}.ct-2f6ba0{color:#D19A66}.ct-43d561{color:#E06C75}.ct-704be1{color:#ABB2BF}"}]}],"toc":{"title":"","searchDepth":2,"depth":2,"links":[{"id":"setup","depth":2,"text":"Setup"}]}},"_type":"markdown","_id":"content:1.getting-started:1.quick-start.md","_source":"content","_file":"1.getting-started/1.quick-start.md","_extension":"md"}