Lightswitch-storefront NPM

Project Lightswitch

Overview

Project Lightswitch is an internal POC / working project, and is based off of the foundation of the vue-storefront and vue-storefront. This project is used as a foundation for a custom extension of the vuestorefront/shopify project.

Project Foundations

This project is a Shopify integration for Vue Storefront 2.
The BORN project Lightswitch/core utilizes an upstream link to the vue-storefront project to pull in bug fixes and future releases as well as the storefront.ui project

Parent Project Structure

vuestorefront v2 <-- storefront.ui `--> vuestorefront/shopify

Lightswitch Project Structure

lightswitch/core <-- vuestorefront (upstream project ) `--> lightswitch/shopify <-- vuestorefront/shopify (upstream project)

How to initialize a new project

STEP 1: Add the @BORN/lightswitch-cli project to your global dependencies

yarn global add lightswitch-storefront

STEP 2: Generate a static project

Many of the default configurations will be fetched from the lightswitch/core project, which then will clone the lightswitch/project into the directory structure once the Shopify platform is selected

#Initialize new project
vsf init <project_name>

STEP 3: Select the Shopify commerce integration

STEP 4: Open the new project in teh terminal

#Open new project directory
cd <project_name>

STEP 5: Install the dependencies for the generated project

#Install dependencies from package.json
yarn install

STEP 6: Compile the front end and start the node.js server

#Compile front end and start front end server
yarn dev

How to start if you want to contribute?

Want to contribute? Ping us on shopify channel on our Discord!

Clone the repo
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.