# Storefront

Netlify Status (opens new window) Publish (opens new window) Build docs (opens new window) CodeFactor (opens new window) License MIT (opens new window) Lerna (opens new window)

๐Ÿš€ Modern and high performant headless eCommerce Storefront:

๐Ÿ“ƒ 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

E-Com Plus Storefront banner