{"id":21431508,"url":"https://github.com/ecomclub/ecomplus-storefront-renderer","last_synced_at":"2026-05-10T02:33:05.919Z","repository":{"id":57219371,"uuid":"118826909","full_name":"ecomclub/ecomplus-storefront-renderer","owner":"ecomclub","description":"Vue.js app to render E-Com Plus store template","archived":false,"fork":false,"pushed_at":"2019-05-27T15:15:49.000Z","size":2745,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-18T11:04:25.791Z","etag":null,"topics":["ecommerce-framework","ecommerce-storefront","ecomplus","jamstack","store-renderer","storefront","vue"],"latest_commit_sha":null,"homepage":"https://developers.e-com.plus/storefront-renderer/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ecomclub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-24T21:52:36.000Z","updated_at":"2020-02-23T23:36:45.000Z","dependencies_parsed_at":"2022-08-29T00:11:23.206Z","dependency_job_id":null,"html_url":"https://github.com/ecomclub/ecomplus-storefront-renderer","commit_stats":null,"previous_names":["ecomclub/ecomplus-store-render"],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomclub%2Fecomplus-storefront-renderer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomclub%2Fecomplus-storefront-renderer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomclub%2Fecomplus-storefront-renderer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ecomclub%2Fecomplus-storefront-renderer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ecomclub","download_url":"https://codeload.github.com/ecomclub/ecomplus-storefront-renderer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243940452,"owners_count":20372087,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ecommerce-framework","ecommerce-storefront","ecomplus","jamstack","store-renderer","storefront","vue"],"created_at":"2024-11-22T23:07:47.940Z","updated_at":"2026-05-10T02:33:00.874Z","avatar_url":"https://github.com/ecomclub.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# storefront-renderer\n\n[![CodeFactor](https://www.codefactor.io/repository/github/ecomclub/storefront-renderer/badge)](https://www.codefactor.io/repository/github/ecomclub/storefront-renderer)\n[![npm version](https://img.shields.io/npm/v/@ecomplus/storefront-renderer.svg)](https://www.npmjs.org/@ecomplus/storefront-renderer)\n[![license mit](https://img.shields.io/badge/License-Apache-orange.svg)](https://opensource.org/licenses/Apache-2.0)\n\nRender E-Com Plus store templates with Vue.js 2.\n\n**[Storefront themes documentation](https://developers.e-com.plus/docs/themes/)**\n\n[Renderer API reference](https://developers.e-com.plus/storefront-renderer/)\n\n## Browser\n\n### Recommended\n\nInclude minified bundle via CDN:\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@ecomplus/storefront-renderer@1/dist/storefront.min.js\"\u003e\u003c/script\u003e\n```\n\nBy default, it declares `Vue`, `Ecom`, `EcomIo` and `EcomInit`\nobjects globally (on browser `window`).\n\n### Standalone\n\nYou can include the render standalone, it **requires** global `EcomIo` object from\n[storefront JS SDK](https://github.com/ecomclub/ecomplus-sdk-js) and\n[Vue](https://vuejs.org/v2/guide/#Getting-Started):\n\n```html\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@ecomplus/storefront-renderer@1/dist/render.min.js\"\u003e\u003c/script\u003e\n```\n\n### With bundlers\n\nIf using `webpack` or `browserify` (or relateds),\nyou can also install the\n[npm package](https://www.npmjs.com/package/@ecomplus/storefront-renderer):\n\n```bash\nnpm install --save @ecomplus/storefront-renderer\n```\n\nAnd import the bundle file:\n\n```js\nimport '@ecomplus/storefront-renderer/dist/storefront.min.js'\n```\n\nYou may also declare imported objects\ninstead of using globals:\n\n```js\nimport { Vue, Ecom, EcomIo, EcomInit } from '@ecomplus/storefront-renderer/dist/storefront.min.js'\n```\n\n## Server side rendering\n\nThe package is also compatible with NodeJS backend,\nhandling SSR with\n[jsdom](https://github.com/jsdom/jsdom) and\n[Vue SSR](https://ssr.vuejs.org/).\n\nEven rendered pages must include the render to run on browser,\nHTML will be updated (hydrate) client-side\nto keep critical data always up to date.\n\n### Command line\n\n```bash\nnpm i -g @ecomplus/storefront-renderer\nstorefront-renderer https://mystore.com/product \u003e product.html\n```\n\n### Node\n\n```javascript\nrequire('@ecomplus/storefront-renderer')(html).then(({ dom, Ecom }) =\u003e {\n  Ecom.init().then(() =\u003e {\n    // jsdom object\n    console.log(dom.serialize())\n  })\n})\n```\n\n## Developing\n\nSetup the package with GitHub and NPM:\n\n```bash\ngit clone https://github.com/ecomclub/storefront-renderer\ncd storefront-renderer\nnpm i\n```\n\nWatch tests server:\n\n```bash\nnpm run serve\n```\n\nUpdate JSDoc files on `docs` folder:\n\n```bash\nnpm run doc\n```\n\nCompile to production:\n\n```bash\nnpm run build\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomclub%2Fecomplus-storefront-renderer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fecomclub%2Fecomplus-storefront-renderer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fecomclub%2Fecomplus-storefront-renderer/lists"}