storefront

KO | EN

gitlite — search

#llm #ai #python #typescript #nextjs #javascript #plugin #mcp #tailwindcss #minecraft #rust #fastapi

★ 100 Open GitHub ↗

Modern and high performant headless eCommerce Storefront. PWA & JAMstack architecture ready for E-Com Plus APIs. Built with Vue.js, extensible through widgets and editable with Netlify CMS.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Storefront

[![Netlify Status](https://api.netlify.com/api/v1/badges/c5f6676c-5b7f-4d5b-b348-b714f56f83d0/deploy-status)](https://app.netlify.com/sites/storefront-template/deploys) [![Publish](https://github.com/ecomplus/storefront/workflows/Publish/badge.svg)](https://github.com/ecomplus/storefront/actions?workflow=Publish) [![Build docs](https://github.com/ecomplus/storefront/workflows/Build%20docs/badge.svg)](https://github.com/ecomplus/storefront/actions?workflow=Build+docs) [![CodeFactor](https://www.codefactor.io/repository/github/ecomplus/storefront/badge)](https://www.codefactor.io/repository/github/ecomplus/storefront) [![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)

:rocket: Modern and high performant **headless eCommerce Storefront**:

- PWA & JAMstack architecture;
- Ready for [E-Com Plus REST APIs](https://developers.e-com.plus/docs/reference/);
- Micro-frontends built with Vue.js 2;
- Extensible through widgets;
- Easy to customize with [Netlify CMS](https://www.netlifycms.org/);
- Conversion focused following [Google Retail UX Playbook](https://services.google.com/fh/files/events/pdf_retail_ux_playbook.pdf);
- [Internationalization support](https://github.com/ecomplus/i18n);
- A11Y compliance;
- Going for Lighthouse :100: overall;

:page_with_curl: **[Explore the docs](https://developers.e-com.plus/storefront/)** · :shopping: [Demo store](https://storefront-demo.e-com.plus) · [Report bug](https://github.com/ecomplus/storefront/issues/new?template=bug_report.md) · [Request feature](https://github.com/ecomplus/storefront/issues/new?template=feature_request.md) · [Forum](https://community.e-com.plus/c/storefront/7) :brazil:

## Quick start for merchants

:zap: Take a look at the **[Storefront Starter](https://github.com/ecomplus/storefront-starter)** if you just want to deploy your [E-Com Plus](https://e-com.plus) store, or go to [customization docs](docs/customization) if you're searching for theming guides.

## Development

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ecomplus/storefront)

Fork/clone this monorepo and install dependencies normally:

```bash
git clone https://github.com/ecomplus/storefront
cd storefront
npm i
```

Then you can edit source files at [`@ecomplus/*`](@ecomplus) folders and test template locally with `npm run serve`.

> As any project maintained with [Lerna](https://lerna.js.org/), you should run commands from root directory.

### Packages

Official packages composing Storefront are [listed here](https://github.com/ecomplus/storefront/packages) with respective description and latest version.

They're published for both [npm](https://www.npmjs.com/) and [GPR](https://github.com/features/packages).

### Contributing

Please read the [contribution guidelines](CONTRIBUTING.md).

<details>
  <summary>
  Check some example useful commands
  </summary>

#### Compile template for production

```bash
npm run build
```

#### Compile all packages

```bash
npx lerna exec -- build
```

#### Serve template locally

```bash
npm run serve
```

#### Serve some specific package tests

```bash
lerna run --scope=@ecomplus/{pkg} serve --stream
```

#### Lint changed files

```bash
npx lerna exec -- lint-staged
```

#### Release and publish all changed packages

```bash
npm run release
```

</details>

![E-Com Plus Storefront banner](https://developers.e-com.plus/storefront/assets/img/banner.png)

storefront

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README