Vue Storefront 2 integration for Orckestra Commerce Platform

---

Requirements

• Node 16+
• Yarn

Getting Started

1. Clone this repository

git clone https://github.com/Orckestra/orc-vsf

2. Install all required dependencies

yarn install

3. Create .env file and set up variables (find .env.example and specify your values)

OVERTURE_URL=
OVERTURE_AUTH_TOKEN=
OVERTURE_SCOPE_NAME=
OVERTURE_INVENTORY_LOCATION_IDS=
SECRET_PASSPHRASE=
MEDIA_SERVER_URL=
MEDIA_FOLDER=

For security purpose, it is important to configure SECRET_PASSPHRASE which is used to encrypt user tokens.

4. Build:

yarn build

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

yarn dev

Changing some parts of the code (notably the api-client) will trigger a re-build but the change will not be hot-reloaded. To ensure that the app sees you changes, re-run either yarn build or yarn dev.

Supported features

Feature	Status	Notes
CMS Intergation	Not Available
Simple menu	Available	with 1st category levels
Mega menu	Available	with 1st/2nd category levels
Quick search	Available
Category Landing Pages	Available
Query/Product Sets Landing Pages	Available
Product details page with variants	Available
Product details page - Related Products	Available
Sorting	Available
Facets	Available	Filters by brand and other factes
Categories Tree with Product Counts	Available
Sign in/ Log out	Available
Sign up	Available
Forgot password	Available
My Account Page	Available
My Orders History	Available
My Order Details Page	Available
My Address Book	Available
Stored payment methods	Not Available
Change Password	Available
Add/Remove/Update to/from Cart	Available	From list, detail pages, cart/wishlist, search suggestions
Sidebar Cart	Available
Standalone cart page	Not Available
Add/Remove to/from Wishlist	Available	From list, detail pages, search suggestions
Sidebar Wishlist	Available
Standalone wishlist page	Not Available
Checkout for Registered User	Available
Checkout for Guest User	Available
Checkout - Personal details	Available
Checkout - Shipping methods	Available
Checkout - Shipping address	Available
Checkout - Pickup location	Available	For Pickup shipping method type
Checkout - Billing address	Available
Checkout - Payment methods	Available
Checkout - Bambora credit card	Available
Store Locator	Not Available
Store Details Page	Not Available
Change Store	Not Available
Internationalization	Available

---

Helpful commands

To increase the version of all packages, use the command:

.\node_modules\.bin\lerna version patch

Resources

• Vue Storefront Documentation
• orc-vsf integration Documentation
• Community Chat

Support

If you have any questions about this integration we will be happy to answer them on orc-vsf channel.

Contributors ✨

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