# Installing on Windows

Vue Storefront is based on open-source technologies, which should (in theory) work perfectly well on most of the leading operating systems. However, we're developing the project using MacOS and Linux machines.

# Requirements

  1. Please download Docker for Windows and install it on your machine. More Information.
  2. Install LTS version of Node.js for Windows.
  3. Instal Yarn.
  4. You can use any editor for development, but we're using Visual Studio Code which is cool, free, and very JS-friendly!
  5. You can download Github Desktop to get access not only for fancy UI, but for the git toolset itself.

# Installation of vue-storefront-api

  1. Open your command line of choice with Git access or use Github desktop.
  2. Clone the vue-storefront-api project:
git clone https://github.com/DivanteLtd/vue-storefront-api.git vue-storefront-api
  1. Go to vue-storefront-api in dir:
cd vue-storefront-api
  1. Install dependencies:
yarn install
  1. Run Docker containers required by vue-storefront-api:
docker-compose up

This step can take a few minutes.

Note: If it appears that docker-compose is hanging, try opening a new terminal and continue to the next step using that terminal. Allow docker-compose to continue running in the background.

  1. Restore products database and run the latest migrations.
yarn restore
yarn migrate
  1. Copy config/default.json to config/local.json.
  2. Run API:
yarn dev

# Installation of vue-storefront

  1. Open your command line of choice with Git access or use Github desktop.
  2. Clone the vue-storefront project:
git clone https://github.com/DivanteLtd/vue-storefront.git vue-storefront
  1. Go to vue-storefront directory:
cd vue-storefront
  1. Install dependencies:
yarn install
  1. Copy config/default.json to config/local.json
  2. Images: because vue-storefront-api uses imagemagick and some nodejs command line bindings, it can be difficult to run the image proxy on a localhost/Windows machine. Please point out the vue-storefront to image proxy provided by changing config/local.json images.baseUrl:
export default {
  elasticsearch: {
    httpAuth: '',
    host: 'localhost:8080/api/catalog',
    index: 'vue_storefront_catalog',
  // we have vue-storefront-api (https://github.com/DivanteLtd/vue-storefront-api) endpoints below:
  orders: {
    endpoint: 'localhost:8080/api/order/create',
  images: {
    baseUrl: 'https://demo.vuestorefront.io/img/',


We're using the powerful node.js library for config files. Check the docs to learn more about it: https://github.com/lorenwest/node-config

  1. Run Vue Storefront Server:
yarn dev

Now you should have Vue Storefront running on localhost:3000.