Skip to content
This repository has been archived by the owner on Mar 24, 2023. It is now read-only.

vuestorefront/ecommerce-integration-boilerplate

Repository files navigation

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 '__replace_me__' ./ | xargs sed -i '' 's/__replace_me__/{YOUR INTEGRATION NAME}/g'

Vue Storefront

Vue Storefront 2 integration with replace_me

Stay connected

GitHub Repo stars Twitter Follow YouTube Channel Subscribers Discord

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 __replace_me__ channel on our Discord!

Requirements:

  • NodeJS v14 or later

Steps

  1. Fork the repo
  2. Clone your fork of the repo
    example:
    git clone https://github.com/vuestorefront/__replace_me__.git
    cd __replace_me__
    
  3. Run yarn to install dependencies
  4. Build dependencies yarn build:api-client && yarn build:composables
  5. 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

Support

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

Contributors ✨

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