Installation

Prerequisites

Before proceeding, make sure you have Node 12 (opens new window) and Yarn 1 (opens new window) installed.

Using Vue Storefront CLI

The easiest way to get started with Vue Storefront is to set up your project using our CLI. You can run it using the npx command:

# Run Vue Storefront CLI
npx @vue-storefront/cli init

Enter the name of the project and select the backend platform you wish to use.

Once selected, the CLI creates the project files in the directory matching your project name. The only thing left is to go to this directory in the terminal and install the dependencies:

# Go to project folder
cd <project_name>

# Install required dependencies
yarn install

Now the project is ready. To start the application in development mode, use the yarn dev command:

# Start the project in development mode
yarn dev

You can read more about available commands and environments on commands (opens new window) page in Nuxt.js documentation.

Recommended tools

Vue.js Devtools

We strongly recommend installing Vue.js Devtools (opens new window) in your browser. It's an excellent tool for viewing component structure and their current state, inspecting events and routes, and much more.

(Vue.js Devtools installation in Chrome browser)

(Vue.js Devtools usage example)

Vetur for VS Code

For those using Visual Studio Code as their main code editor, we also recommend using Vetur extension (opens new window). It speeds up the development of Vue.js-based applications by providing, amongst many others, features like Vue.js code autocompletion and syntax highlighting.

To install Vetur extension:

1. Open VS Code
2. Open Extensions
3. Search for Vetur
4. Click Install

(Vetur installation in Visual Studio Code marketplace)

(Example of code autocompletion provided by Vetur)

What's next?

If you want to learn more, check out the Introduction to Vue Storefront. You can also check the platform-specific documentation on the Integrations page.