{"id":26690512,"url":"https://github.com/selldone/storefront-sdk","last_synced_at":"2025-03-26T15:29:22.890Z","repository":{"id":196630076,"uuid":"696138612","full_name":"selldone/storefront-sdk","owner":"selldone","description":"A JavaScript toolkit for creating custom storefront layouts for shops built with Selldone, complete with ready-to-use SDK features","archived":false,"fork":false,"pushed_at":"2024-06-23T17:44:05.000Z","size":1789,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-06-27T09:57:41.263Z","etag":null,"topics":["business-os","ecommerce-sdk","ecommerce-website-front-end","selldone","shop-sdk","storefront"],"latest_commit_sha":null,"homepage":"https://selldone.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/selldone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-25T07:00:08.000Z","updated_at":"2024-07-27T14:56:21.719Z","dependencies_parsed_at":null,"dependency_job_id":"28c77b0b-bd3c-42b5-877b-6558d19d84cd","html_url":"https://github.com/selldone/storefront-sdk","commit_stats":null,"previous_names":["selldone/storefront-sdk"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selldone%2Fstorefront-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selldone%2Fstorefront-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selldone%2Fstorefront-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/selldone%2Fstorefront-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/selldone","download_url":"https://codeload.github.com/selldone/storefront-sdk/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245680789,"owners_count":20655085,"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":["business-os","ecommerce-sdk","ecommerce-website-front-end","selldone","shop-sdk","storefront"],"created_at":"2025-03-26T15:29:22.143Z","updated_at":"2025-03-26T15:29:22.877Z","avatar_url":"https://github.com/selldone.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Selldone Official Storefront App](_docs/images/banner-storefront-sdk.jpg)\n\n\u003ca href=\"https://www.npmjs.com/package/@selldone/sdk-storefront\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@selldone/sdk-storefront.svg?sanitize=true\" alt=\"Version\"\u003e\u003c/a\u003e\n![Selldone](https://img.shields.io/badge/type-Selldone-f39f37?style=flat\u0026label=Storefront\u0026labelColor=%23567\u0026color=%23000)\n![License](https://img.shields.io/github/license/selldone/storefront-sdk.svg)\n[![GitHub](https://img.shields.io/badge/GitHub-Storefront--SDK-blue?style=flat\u0026logo=github)](https://github.com/selldone/storefront-sdk)\n\n# Selldone ⮕ Storefront SDK\n\n* **Mode:** 🌍 Public\n* **Use case:** To build custom storefront layout for shops that created by Selldone with ready to use SDK.\n* **Project Type:** JS Library\n\n🛍️ Go to the [**Full Storefront Project ▶**](https://github.com/selldone/storefront)\n\nA powerful toolkit that enables developers and entrepreneurs to easily create highly customized ecommerce platforms. In\nthis article, we'll explore the capabilities of the Selldone SDK and how it can revolutionize the ecommerce landscape.\n\n# Documents\n\n| Category                   | Description                                                                                                                                                     | Namespace                     |\n|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|\n| **[Authentication](auth)** | User authentication methods with social, sms, email                                                                                                             | `window.$storefront.auth`     |\n| **[Product](product)**     | Retrieve product listings, detailed information, search for products, manage customer-related actions such as rating products, and access subscription content. | `window.$storefront.products` |\n| **[Basket](basket)**       | Create order, add and remove items and checkout.                                                                                                                | `window.$storefront.basket`   |\n\n# Starter\n\n## Installation\n\nTo install Selldone Core in your project, use the following command:\n\n```bash\nnpm install @selldone/sdk-storefront\n```\n\n```bash\nyarn add @selldone/sdk-storefront\n```\n\n## Usage\n\nHere's a basic example to get you started:\n\n### Use in Vue, React, Bootstrap, or any other JS Framework\n\n```javascript\nimport {StorefrontSDK} from \"@selldone/sdk-storefront\";\n\n// ━━━ Storefront SDK (xapi,...) ━━━\nStorefrontSDK.Setup(); // Set up the Shop SDK.\n```\n\n### Use in Html\n\n```html  \n\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@selldone/sdk-storefront@{version}/dist/bundle.min.js\"\u003e\u003c/script\u003e\n\u003cscript\u003e\n    // Use the global variable StorefrontSDK\n    const sdk = storefront.StorefrontSDK;\n    sdk.Setup()\n\u003c/script\u003e\n```\n\n⚡ Change `{version}` to last version: \u003ca href=\"https://www.npmjs.com/package/@selldone/sdk-storefront\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@selldone/sdk-storefront.svg?sanitize=true\" alt=\"Version\"\u003e\u003c/a\u003e\n\nOther CDN Options:\n```html\nYou can always fetch the latest version of @selldone/sdk-storefront using jsDelivr’s latest version alias:\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@selldone/sdk-storefront@latest/dist/bundle.min.js\"\u003e\u003c/script\u003e\n\nAlternative (Using Unpkg)\nIf you prefer unpkg, you can use:\n\u003cscript src=\"https://unpkg.com/@selldone/sdk-storefront/dist/bundle.min.js\"\u003e\u003c/script\u003e\n\n⚠️ Important:\nUsing @latest can sometimes break your app if new versions introduce breaking changes. If stability is a concern, it's best to specify a fixed version or use semantic versioning, e.g.:\n\u003cscript src=\"https://cdn.jsdelivr.net/npm/@selldone/sdk-storefront@1/dist/bundle.min.js\"\u003e\u003c/script\u003e\n```\n\n### Add Meta Tags to HTML\n\nTo integrate your web application with the Selldone ecosystem effectively, it's essential to embed specific meta tags\nwithin the \u003chead\u003e section of your HTML. These tags enable the Selldone SDK to establish a connection with the Selldone\nAPI, facilitating the retrieval of your shop's data.\n\n```html\n\u003c!-- 🏬 Shop Name --\u003e\n\u003cmeta name=\"shop-name\" content=\"toysworld\"\u003e\n\n\u003c!-- 🎗 Prefix address of app Ex./my-shop-path --\u003e\n\u003cmeta name=\"shop-prefix-address\" content=\"\"\u003e\n\n\u003c!-- 📰 Shop custom page --\u003e\n\u003cmeta name=\"custom-home\" content=\"shop\"\u003e\n\n\n\u003c!-- ―――――――――――――――― Start ❯ Business OS Configuration ―――――――――――――――― --\u003e\n\n\u003c!-- 🪁 Service Origin --\u003e\n\u003cmeta content=\"https://selldone.com\" name=\"service-url\"\u003e\n\n\n\u003c!-- 🎯 APIs --\u003e\n\u003cmeta content=\"https://gapi.selldone.com\" name=\"selldone-gapi\"\u003e\n\u003cmeta content=\"https://xapi.selldone.com\" name=\"selldone-xapi\"\u003e\n\u003cmeta content=\"https://iframe.selldone.com\" name=\"selldone-iframe\"\u003e\n\u003cmeta content=\"https://capi.selldone.com\" name=\"selldone-capi\"\u003e\n\n\u003c!-- 🌍 CDNs --\u003e\n\u003cmeta content=\"https://selldone.com/cdn-shop-images-1\" name=\"selldone-cdn-images\"\u003e\n\u003cmeta content=\"https://selldone.com/cdn-shop-jsons-1\" name=\"selldone-cdn-jsons\"\u003e\n\u003cmeta content=\"https://selldone.com/cdn-videos\" name=\"selldone-cdn-videos\"\u003e\n\u003cmeta content=\"https://selldone.com/cdn-shop-temp-files\" name=\"selldone-cdn-temp-files\"\u003e\n\u003cmeta content=\"https://selldone.com/cdn-ar\" name=\"selldone-cdn-ar\"\u003e\n\u003cmeta content=\"https://selldone.com/cdn-id\" name=\"selldone-cdn-id\"\u003e\n\u003cmeta content=\"true\" name=\"storage-redirect\"\u003e\n\u003cmeta content=\"https://cdn.selldone.com\" name=\"storage-redirect-host\"\u003e\n\u003cmeta content=\"true\" name=\"storage-redirect-thumbnails\"\u003e\n\n```\n\n## Articles \u0026 Live Samples\n\n* **Medium Article:** [Build E-Commerce with Open-Source Selldone — Fetch List of Products + Vue3 Sample](https://pajuhaan.medium.com/build-e-commerce-with-open-source-selldone-fetch-list-of-products-vue3-sample-9e61108b0ca6)\n* **Live Sample Code:** https://codepen.io/pajuhaan/pen/pomvQWr\n\n# About\n\n### Selldone SDK - Custom Ecommerce Development Toolkit\n\nThe Selldone SDK offers essential components for creating online storefronts and managing customer authentication. With\nits open-source tools, developers can build custom ecommerce platforms tailored to specific needs.\n\n![Selldone Components](./_docs/images/selldone-screenshot.jpg)\n\n### Easy to Use\n\nEven with just three months of JavaScript and HTML experience, users can create a fully customized online store in a\nday, making Selldone SDK ideal for developers and entrepreneurs alike.\n\n### Unlimited Customization\n\nThe SDK allows for extensive customization of components, enabling developers to build specialized ecommerce solutions\nfor various industries and sell them as SaaS products.\n\n### SaaS Solutions with Selldone SDK\n\nDevelop SaaS solutions without backend coding. For instance, create a subscription service for marketing analysis or a\nplatform for selling training courses, all powered by Selldone.\n\n#### Case Study 1: Host Web App on My Backend\n\n1. Create an app with Selldone components.\n2. Develop a website with a home page and onboarding.\n3. Define subscription plans, code to sell subscriptions, and host the web app.\n4. Users subscribe, connect their Selldone shop, and offer their services.\n\n![Self hosted app strategy](_docs/images/selldone-saas-hosting-strategies-1.jpg)\n\n#### Case Study 2: Host Web App on Selldone\n\n1. Create a custom web app with Selldone components.\n2. Register and verify as a SaaS owner on Selldone.\n3. Deploy the web app on Selldone and charge users via Selldone's subscription service.\n\n![Server-less app strategy](_docs/images/selldone-saas-hosting-strategies-2.jpg)\n\n### Build with AI + Selldone\n\nChoose a niche, design your application layer with Midjourny, and request code implementation using Selldone Components.\nCustomize components with AI services like ChatGPT, BART, or Selldone's AI offerings, and launch your platform-based\nbusiness.\n\n## Author\n\nPajuhaan\n\n## License\n\n**Selldone Ecosystem License Agreement**\n\n1. **Scope of License**: This license is granted exclusively for the use of the enclosed code (hereinafter referred to\n   as \"the Code\") within the Selldone ecosystem. The licensee is authorized to use the Code solely in conjunction with\n   services and applications that are part of, or directly related to, the Selldone ecosystem.\n\n2. **Commercial Use Restriction**: The licensee is strictly prohibited from using the Code for any commercial purposes\n   outside the Selldone ecosystem. Commercial utilization is permissible only when it is within the Selldone ecosystem\n   and in accordance with the terms of this agreement.\n\n3. **Permission for Free Use**: The Code may be used for non-commercial, free services, provided that explicit credit is\n   given to Selldone. This credit must include the name \"Selldone\" prominently displayed on the user interface of the\n   relevant service or application, along with a hyperlink to [selldone.com](https://selldone.com).\n\n4. **No Redistribution**: The licensee may not redistribute the Code, in whole or in part, to any third party outside\n   the Selldone ecosystem, unless expressly authorized by Selldone.\n\n5. **No Modification for Redistribution**: While modifications to the Code for personal or internal use within the\n   Selldone ecosystem are allowed, the licensee may not modify the Code for the purpose of redistribution outside the\n   Selldone ecosystem.\n\n6. **Termination**: Failure to comply with the terms of this agreement will result in the immediate termination of the\n   license and may subject the licensee to legal action.\n\n7. **Disclaimer of Warranty**: The Code is provided \"as is\" without any warranties of any kind, either expressed or\n   implied, including but not limited to implied warranties of merchantability or fitness for a particular purpose.\n\n8. **Limitation of Liability**: In no event shall Selldone be liable for any damages arising out of the use or inability\n   to use the Code.\n\n9. **Jurisdiction and Disputes**: This agreement shall be governed by the laws of the jurisdiction where Selldone is\n   established. Any disputes arising from this agreement shall be resolved in the courts of that jurisdiction.\n\nBy using the Code, the licensee acknowledges that they have read, understood, and agreed to the terms of this license.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselldone%2Fstorefront-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fselldone%2Fstorefront-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fselldone%2Fstorefront-sdk/lists"}