Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ecomplus/storefront
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.
https://github.com/ecomplus/storefront
bootstrap4 e-commerce ecomplus ejs-templates headless-ecommerce jamstack-storefront micro-frontend monorepo netlify-cms pwa-ecommerce storefront ui-components vue webpack-boilerplate
Last synced: 16 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/ecomplus/storefront
- Owner: ecomplus
- License: mit
- Created: 2019-08-07T13:15:50.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T16:14:55.000Z (17 days ago)
- Last Synced: 2024-10-29T17:13:51.676Z (17 days ago)
- Topics: bootstrap4, e-commerce, ecomplus, ejs-templates, headless-ecommerce, jamstack-storefront, micro-frontend, monorepo, netlify-cms, pwa-ecommerce, storefront, ui-components, vue, webpack-boilerplate
- Language: JavaScript
- Homepage: https://developers.e-com.plus/storefront/
- Size: 74.7 MB
- Stars: 101
- Watchers: 6
- Forks: 35
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Storefront
[](https://app.netlify.com/sites/storefront-template/deploys) [](https://github.com/ecomplus/storefront/actions?workflow=Publish) [](https://github.com/ecomplus/storefront/actions?workflow=Build+docs) [](https://www.codefactor.io/repository/github/ecomplus/storefront) [](https://opensource.org/licenses/MIT) [](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
[](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).
Check some example useful commands
#### 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
```
