Boilerplate for Vue Storefront 2 eCommerce integration

This is a template, to use it you must rename the project changing the {YOUR INTEGRATION NAME} to the name of the integration you are developing. The name must be in lowercase and without any special characters.

grep -rl '<% INTEGRATION %>' ./ | xargs sed -i '' 's/<% INTEGRATION %>/{YOUR INTEGRATION NAME}/g'

Vue Storefront 2 integration with <% INTEGRATION %>

To learn how to build your integration, see our Integration guide.

How to start if you want to try out the integration

yarn global add @vue-storefront/cli

vsf init <project_name> && cd <project_name> && yarn && yarn dev

How to start if you want to contribute?

Want to contribute? Ping us on <% INTEGRATION %> channel on our Discord!

Requirements:

NodeJS v14 or later

Steps

Fork the repo

Clone your fork of the repo

example:
git clone https://github.com/vuestorefront/<% INTEGRATION %>.git
cd <% INTEGRATION %>

Run yarn to install dependencies
Build dependencies yarn build:api-client && yarn build:composables
Run yarn dev:theme to run theme. You can find other commands in package.json

If you need HMR on Api Client/Composables run yarn dev:api-client or yarn dev:composables on a separate terminal window.

Resources

Vue Storefront Documentation
[<% INTEGRATION %> integration Documentation](https://docs.vuestorefront.io/<% INTEGRATION %>)
Community Chat

Support

If you have any questions about this integration we will be happy to answer them on <% INTEGRATION %> channel on our Discord.

Contributors ✨

This project follows the all-contributors specification. Contributions of any kind welcome!

althafn96/vue-storefront-demo