# Storefront
(opens new window) (opens new window) (opens new window) (opens new window) (opens new window) (opens new window)
🚀 Modern and high performant headless eCommerce Storefront:
- PWA & JAMstack architecture;
- Ready for E-Com Plus REST APIs (opens new window);
- Micro-frontends built with Vue.js 2;
- Extensible through widgets;
- Easy to customize with Netlify CMS (opens new window);
- Conversion focused following Google Retail UX Playbook (opens new window);
- Internationalization support (opens new window);
- A11Y compliance;
- Going for Lighthouse 💯 overall;
📃 Explore the docs (opens new window) · 🛍 Demo store (opens new window) · Report bug (opens new window) · Request feature (opens new window) · Forum (opens new window) 🇧🇷
# Quick start for merchants
⚡️ Take a look at the Storefront Starter (opens new window) if you just want to deploy your E-Com Plus (opens new window) store, or go to customization docs if you're searching for theming guides.
# Development
Fork/clone this monorepo and install dependencies normally:
git clone https://github.com/ecomplus/storefront
cd storefront
npm i
Then you can edit source files at @ecomplus/*
folders and test template locally with npm run serve
.
As any project maintained with Lerna (opens new window), you should run commands from root directory.
# Packages
Official packages composing Storefront are listed here (opens new window) with respective description and latest version.
They're published for both npm (opens new window) and GPR (opens new window).
# Contributing
Please read the contribution guidelines.
Check some example useful commands
# Compile template for production
npm run build
# Compile all packages
npx lerna exec -- build
# Serve template locally
npm run serve
# Serve some specific package tests
lerna run --scope=@ecomplus/{pkg} serve --stream
# Lint changed files
npx lerna exec -- lint-staged
# Release and publish all changed packages
npm run release