{"id":19312145,"url":"https://github.com/bigcommerce/widget-builder","last_synced_at":"2026-03-01T13:35:09.324Z","repository":{"id":41774930,"uuid":"208891292","full_name":"bigcommerce/widget-builder","owner":"bigcommerce","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-07T15:53:30.000Z","size":779,"stargazers_count":19,"open_issues_count":25,"forks_count":42,"subscribers_count":31,"default_branch":"master","last_synced_at":"2025-04-22T15:44:47.809Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/bigcommerce.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2019-09-16T20:24:45.000Z","updated_at":"2024-12-10T22:30:02.000Z","dependencies_parsed_at":"2024-04-17T09:26:51.857Z","dependency_job_id":"9ac41870-5de0-4ab6-9c61-821a30cea9e5","html_url":"https://github.com/bigcommerce/widget-builder","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/bigcommerce/widget-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fwidget-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fwidget-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fwidget-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fwidget-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigcommerce","download_url":"https://codeload.github.com/bigcommerce/widget-builder/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigcommerce%2Fwidget-builder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29970473,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T13:32:00.443Z","status":"ssl_error","status_checked_at":"2026-03-01T13:32:00.084Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":[],"created_at":"2024-11-10T00:33:12.243Z","updated_at":"2026-03-01T13:35:09.306Z","avatar_url":"https://github.com/bigcommerce.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Widget Builder [![CircleCi](https://circleci.com/gh/bigcommerce/widget-builder.svg?style=svg\u0026circle-token=b4d4a370c5cdee3585da202fd0e81a9febbb6059)](https://circleci.com/gh/bigcommerce/widget-builder)\n\n\u003cdiv class=\"otp\" id=\"no-index\"\u003e\n\n### Table of contents\n- [Prerequisites](#prerequisites)\n- [Installing Widget Builder](#installing-widget-builder)\n- [Configuring Widget Builder](#configuring-widget-builder)\n- [Building widgets](#building-widgets)\n- [Publishing to store](#publishing-to-store)\n- [Contributions](#contributions)\n- [Issues/Bugs](#issues--bugs)\n- [Resources](#resources)\n\n\u003c/div\u003e\n\nWidget Builder is a command-line tool that lets you build, edit, and preview custom storefront widgets in real-time outside the context of your BigCommerce store.\n\nThis article contains detailed instructions on how to get started with Widget Builder. \n\n## Prerequisites\n\n* Node.js 18\n* npm 9.51\n* [A BigCommerce store](https://support.bigcommerce.com/s/article/Starting-a-Bigcommerce-Trial).\n* API `access_token` with `content modify` scope. For information on how to generate store API credentials, see [Obtaining store API credentials](https://developer.bigcommerce.com/api-docs/getting-started/authentication/rest-api-authentication#obtaining-store-api-credentials).\n\n## Installing Widget Builder\n\nFollow these instructions to install Widget Builder and its dependencies. \n\n1. In a terminal, clone the [widget-builder](https://github.com/bigcommerce/widget-builder) GitHub repo.\n\n2. Navigate to the `widget-builder` directory and install Widget Builder.\n\n```shell\nnpm run install-cli\n```\n\n3. To retrieve usage information and view supported options and commands, run the following command:\n\n```shell\nwidget-builder -h\n```\n\n**Sample output:**\n\n```shell\nUsage: widget-builder [options] [command]\n\nOptions:\n  -V, --version                  output the version number\n  --gen-config                   generate a config.json file\n  --gen-query-params             generate a queryParams.json file\n  --auto-open \u003cflag\u003e             open browser automatically to the builder\n                                 preview (default: \"true\")\n  -h, --help                     display help for command\n\nCommands:\n  init                           Initialization of widget builder configuration\n  start [options] [widgetPath]   starts the widget builder locally\n  validate [options] \u003cfile\u003e\n  create \u003cwidget-template-name\u003e  Create a blank widget template\n  publish \u003cwidget-template\u003e      Releases the widget template to the store\n                                 belonging to the env config\n  help [command]                 display help for command\n```\n\n\u003cdiv class=\"HubBlock--callout\"\u003e\n\u003cdiv class=\"CalloutBlock--info\"\u003e\n\u003cdiv class=\"HubBlock-content\"\u003e\n\n\u003c!-- theme: info --\u003e\n\n\u003e Refer to [Widget Builder README.MD](https://github.com/bigcommerce/widget-builder) for the latest supported `node` version.\n\n\u003c/div\u003e\n\u003c/div\u003e\n\u003c/div\u003e\n\n## Configuring Widget Builder\n\nOnce you have installed Widget Builder, the next step is to set up your store's environment. You will need the store's Client ID, Access Token, and API Path to generate appropriate configurations. \n\nTo get started, run the following command:\n\n```shell\nwidget-builder init\n```\n\nWhen prompted, enter your API account credentials. This will create the `.env` file with the necessary parameter assignments.\n\n**Sample output:**\n\n```shell\nThank you for using Widget Builder\n\n            \nThis guide will help you get your environment set up.\n\nBefore continuing, please make sure you've created or received a Store API account.\nYou'll need those credentials in order to generate the appropriate configurations.\nYou can find more information here. https://support.bigcommerce.com/s/article/Store-API-Accounts#creating\n\n? Are you ready to continue? You may press any key to continue Yes\n? What is the Client ID? xxxxxxxxxxxxx\n? What is the Access Token? xxxxxxxxxxxxx\n? What is the API Path? https://api.bigcommerce.com/stores/xxxxx/v3/\n[2021-09-08T15:12:40.271Z] Successfully created your configuration, you're all set!\n```\n### Resetting configurations\n\nIf you need to reset the configurations, run the `widget-builder init` command to overwrite the existing assignments.\n\n## Building widgets\n\nTo start Widget Builder locally, open the directory containing your widget template files and run the following command:\n\n```shell\nwidget-builder start [path to widget template]\n```\nYour default browser should open automatically on port 8080.\n\n### Starter template\n\nTo jump start widget development, Widget Builder provides a blank template with the appropriate files needed to start building widgets. To use the starter template, run the following command:\n\n```shell\nwidget-builder create [widget template name]\n```\n\n**Sample output:**\n\n```shell\n[2021-09-08T17:29:38.868Z] Successfully created ./test-widget-one \n[2021-09-08T17:29:38.870Z] Successfully created schema.json in ./test-widget-one/schema.json\n[2021-09-08T17:29:38.871Z] Successfully created config.json in ./test-widget-one/config.json\n[2021-09-08T17:29:38.871Z] Successfully created widget.html in ./test-widget-one/widget.html\n[2021-09-08T17:29:39.564Z] Starting widget-builder at http://localhost:8080!\n[2021-09-08T17:29:39.887Z] Socket connected.\n```\n\nYour default browser should open automatically and display a text widget on port 8080.\n\n## Publishing to store\n\nTo publish a widget to your BigCommerce store, run the following command:\n\n```shell\nwidget-builder publish [path to widget template]\n```\n\n## Contributions\n\nIf you wish to contribute, please refer to our [contribution guide](CONTRIBUTING.md)\nand [code of conduct](CODE_OF_CONDUCT.md) for this project.\n\n## Issues / Bugs\n\n* Please include a clear, specific title and replicable description.\n\n* Please include your environment, OS, and any exceptions/backtraces that occur. The more\ninformation that is given, the more likely we can debug and fix the issue.\n\n**If you find a security bug, please do not post as an issue. Send directly to [security@bigcommerce.com](mailto:security@bigcommerce.com)\ninstead.**\n\nThank you again for your interest in contributing to the Widget Builder!\n\nCopyright (C) 2019-Present BigCommerce Inc. All rights reserved.\n\n## Resources\n\n* [Authenticating BigCommerce's REST APIs](https://developer.bigcommerce.com/api-docs/getting-started/authentication/rest-api-authentication)\n* [Widgets API Overview](https://developer.bigcommerce.com/api-docs/store-management/widgets/overview)\n* [Widget Builder GitHub repository](https://github.com/bigcommerce/widget-builder)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fwidget-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigcommerce%2Fwidget-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigcommerce%2Fwidget-builder/lists"}