Vue Storefront for Vue (Nuxt 3) Boilerplate

Getting Started with Vue Storefront

To get started, see the following guides:

• Introduction to learn what is Vue Storefront.
• Storefronts in Vue Storefront ecosystem

Prerequisites:

• Node.js 20+
• Yarn

Local dev setup

1. Clone the repository.

$ git clone [email protected]:vuestorefront/storefront-nuxt3-boilerplate.git

2. Install all dependencies (read here How to install Yarn 3).

$ yarn install

3. Run development server. App will be served with hot reload at localhost:3000.

$ yarn dev

Features:

• Turborepo remote cache build system, with blazingly fast execution of commands (build, lint, test etc.) on your local machine.
• TypeScript support.
• Nuxt.js 3 & Server Side Rendering for great UX, loading and SEO scores.
• Beautiful components built with TailwindCSS and Storefront UI - a lightweight, accessible, and customizable component library built for e-commerce.
• Unit tests with Vitest and Vue Test Utils.
• ESLint for code linting.
• Prettier code formatter.
• Husky for working with Git hooks efficiently.
• Conventional Commits standard for commit messages.
• Staged code linting with lint-staged.
• Progressive Web App features with Vite PWA for Nuxt.
• i18n localisation powered by Nuxt-i18n.
• Vue Storefront SDK ready - integrate headless E-commerce platform with your project easily.
• Vue Storefront Middleware.
• Maximize lighthouse score.

Guide

Refer to Guide

License

Distributed under the MIT License. See LICENSE for more information.

Contributing

Please see our contributing.md for more information.

Resources

• Vue Storefront Documentation
• Vue Storefront Enterprise Documentation
• Storefront UI 2 Documentation
• Community Chat

Support

If you have any questions about this integration we will be happy to answer them on general-help channel on our Discord.