{"id":13722335,"url":"https://github.com/meilisearch/ecommerce-demo","last_synced_at":"2025-05-07T15:30:37.866Z","repository":{"id":172753473,"uuid":"595979755","full_name":"meilisearch/ecommerce-demo","owner":"meilisearch","description":"Nuxt 3 ecommerce site  search with filtering and facets powered by Meilisearch","archived":false,"fork":false,"pushed_at":"2025-04-16T08:28:04.000Z","size":22201,"stargazers_count":99,"open_issues_count":6,"forks_count":18,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-05-04T04:09:36.869Z","etag":null,"topics":["ecommerce","faceted-search","meilisearch","nuxt"],"latest_commit_sha":null,"homepage":"https://ecommerce.meilisearch.com/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=website-url","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"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":null,"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,"zenodo":null}},"created_at":"2023-02-01T07:55:37.000Z","updated_at":"2025-05-02T10:33:17.000Z","dependencies_parsed_at":"2025-04-05T13:33:37.086Z","dependency_job_id":null,"html_url":"https://github.com/meilisearch/ecommerce-demo","commit_stats":null,"previous_names":["meilisearch/ecommerce-demo"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fecommerce-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fecommerce-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fecommerce-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/meilisearch%2Fecommerce-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/meilisearch","download_url":"https://codeload.github.com/meilisearch/ecommerce-demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252905516,"owners_count":21822819,"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":["ecommerce","faceted-search","meilisearch","nuxt"],"created_at":"2024-08-03T01:01:27.558Z","updated_at":"2025-05-07T15:30:32.853Z","avatar_url":"https://github.com/meilisearch.png","language":"Vue","funding_links":[],"categories":["Demos"],"sub_categories":["Community Tools"],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.meilisearch.com/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://github.com/meilisearch/meilisearch/blob/main/assets/logo.svg\" alt=\"Meilisearch\" width=\"200\" height=\"200\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003eMeilisearch Nuxt 3 ecommerce demo\u003c/h1\u003e\n\n\u003ch4 align=\"center\"\u003e\n  \u003ca href=\"https://www.meilisearch.com/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme\"\u003eWebsite\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/cloud?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme\"\u003eMeilisearch Cloud\u003c/a\u003e |\n  \u003ca href=\"https://blog.meilisearch.com/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme\"\u003eBlog\u003c/a\u003e |\n  \u003ca href=\"https://www.meilisearch.com/docs/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme\"\u003eDocumentation\u003c/a\u003e |\n  \u003ca href=\"https://discord.meilisearch.com/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme\"\u003eDiscord\u003c/a\u003e\n\u003c/h4\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/meilisearch/demo-movies/blob/main/LICENCE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-informational\" alt=\"License\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\n\u003e Meilisearch is an open-source search engine that offers fast, relevant search out of the box. \n\n## 💪 Looking to build this yourself?\n\nRead our [Step by step guide to adding site search to your Nuxt ecommerce](https://blog.meilisearch.com/nuxt-ecommerce-search-guide/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme)!\n\n## ✨ Features\n\nThis ecommerce demo uses:\n\n- [Faceted search](https://www.meilisearch.com/docs/learn/fine_tuning_results/faceted_search?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme)\n- [Filtering](https://www.meilisearch.com/docs/learn/fine_tuning_results/filtering?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme)\n- [Sorting](https://www.meilisearch.com/docs/learn/fine_tuning_results/sorting?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme)\n\n## 🧰 Stack\n\nThis project requires:\n\n- [Node 18](https://nodejs.org/)\n- [Yarn 3](https://yarnpkg.com/getting-started/install) — Node.js package manager\n- [Nuxt 3](https://nuxt.com) — Web application framework based on [Vue 3](https://vuejs.org/)\n- [Meilisearch](https://meilisearch.com/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme) — Fast, relevant search engine\n\nThis projects uses icons from [Heroicons](https://heroicons.com/) and social medias icons from [icons8](https://icons8.com/icons/collections/EnE9mEHAiX2D).\n\n## 🛠️ Setup\n\n### Dependencies\n\n\u003e **Warning**\n\u003e Ensure that you are using a Node version compatible with the one in `.nvmrc`.\n\nInstall the dependencies with Yarn 3:\n\n```bash\nyarn install\n```\n\n### Environment\n\nEnvironment variables should hold your Meilisearch database credentials. The easiest way to launch a database is to create a project on [Meilisearch Cloud](https://meilisearch.com/cloud?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme). Alternatively, you can read [local installation](https://www.meilisearch.com/docs/learn/getting_started/installation?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme#local-installation) documentation for self-hosted options.\n\nThis project loads environment variables from an `.env` file. Copy `.env.example` file  as `.env` and update the file's content to match your credentials.\n\n```bash\n# .env\n\n# Meilisearch configuration\nMEILISEARCH_HOST=\"use the Database URL here\"\nMEILISEARCH_ADMIN_API_KEY=\"use the Default Admin API Key here\"\nMEILISEARCH_SEARCH_API_KEY=\"use the Default Search API Key here\"\n\n# Image optimization configuration\nTWICPICS_DOMAIN=https://meilisearch-ecommerce.twic.pics\nSTORYBOOK_TWICPICS_DOMAIN=https://meilisearch-ecommerce.twic.pics\n```\n\n\u003e This application uses [TwicPics](https://twicpics.com/) to deliver optimized images. You don’t need to update the related environment variables. \n\n### Database\n\nThis projects comes with a setup script: `database/setup.js`. This script seeds a `products` index using the dataset in `database/data.json`.\n\nThis sample dataset is used the [tutorial](https://blog.meilisearch.com/nuxt-ecommerce-search-guide/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme), which pertains to the code on branches `1-setup-database`, `2-search-as-you-type`, `3-advanced-search-patterns`, and `4-final`.\n\nRun the setup script to configure and seed your Meilisearch instance:\n\n```bash\nyarn setup\n```\n\n\u003e **Note**\n\u003e The [live demo](https://ecommerce.meilisearch.com/?utm_campaign=ecommerce-demo\u0026utm_source=github\u0026utm_medium=readme) uses a different dataset and Meilisearch instance. The `main` branch is the reference for this site.\n\n## 🧑‍💻 Development\n\n\u003e **Note**\n\u003e Make sure to complete instructions from the Setup section before running the server.\n\nStart the development server on http://localhost:3000\n\n```bash\nyarn dev\n```\n\n## 🚀 Deployment\n\nBuild the application for production:\n\n```bash\nyarn build\n```\n\nLocally preview production build:\n\n```bash\nyarn preview\n```\n\nCheck out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.\n\n## ✨ Storybook\n\nThis project uses [Storybook v7](https://storybook.js.org/) to document components. The `vite.config.ts` is used by Storybook to enable auto-imports and path aliases.\n\nOpen Storybook by running:\n\n```bash\nyarn storybook\n```\n\n\u003e Output files `auto-imports.d.ts` and `components.d.ts` are auto-generated and *should not* be updated manually. You can commit them into source control.\n\nLearn more about [configuring Storybook for Nuxt](https://laurentcazanove.com/articles/storybook-nuxt-guide/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeilisearch%2Fecommerce-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmeilisearch%2Fecommerce-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmeilisearch%2Fecommerce-demo/lists"}