Vue Storefront 2 integration

1. Overview

Propeller Commerce provides the GraphQL API which can be hooked to VueStorefront.

Propeller VSF monorepo contains three submodules

1. API-client - low level backend API connector, utilizing Propeller GraphQL API
2. Composables - reusable business logic
3. Theme - Nuxt.js-based frontend application

2. Requirements

Node 16+

3. Getting Started

1. Add Propeller Backend to Vue Storefront

• Vue CLI (https://cli.vuejs.org/guide/)

  • Provide Propeller git repo as backend on CLI initialization

• Clone git repo

git clone https://github.com/propeller-commerce/vuestorefront.git

2. Install all required dependencies

yarn install

3. Set backend URL via env variable (or create .env file inside Theme folder)

export PROPELLER_ENDPOINT=PropellerEndpointHere

export PROPELLER_APIKEY=YourPropellerApiKeyHere

4. Then verify if everything works properly by building all three projects:

yarn build

5. If everything is built properly, you can start working on your new frontend with:

yarn dev

NPM packages

Composables: https://www.npmjs.com/package/@propeller-commerce/propeller

Api-client: https://www.npmjs.com/package/@propeller-commerce/propeller-api

Install Propeller package

npm i @propeller-commerce/propeller

This will also install api-client package as dependency to composables package.