You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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).
--gen-query-params generate a queryParams.json file
55
-
--auto-open <flag> open browser automatically to the builder
56
-
preview (default: "true")
57
52
-h, --help display helpforcommand
58
53
59
54
Commands:
@@ -66,18 +61,6 @@ Commands:
66
61
help [command] display helpforcommand
67
62
```
68
63
69
-
<divclass="HubBlock--callout">
70
-
<divclass="CalloutBlock--info">
71
-
<divclass="HubBlock-content">
72
-
73
-
<!-- theme: info -->
74
-
75
-
> Refer to [Widget Builder README.MD](https://github.com/bigcommerce/widget-builder) for the latest supported `node` version.
76
-
77
-
</div>
78
-
</div>
79
-
</div>
80
-
81
64
## Configuring Widget Builder
82
65
83
66
Once 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.
@@ -90,24 +73,7 @@ widget-builder init
90
73
91
74
When prompted, enter your API account credentials. This will create the `.env` file with the necessary parameter assignments.
92
75
93
-
**Sample output:**
94
-
95
-
```shell
96
-
Thank you for using Widget Builder
97
-
98
-
99
-
This guide will help you get your environment set up.
100
-
101
-
Before continuing, please make sure you've created or received a Store API account.
102
-
You'll need those credentials in order to generate the appropriate configurations.
103
-
You can find more information here. https://support.bigcommerce.com/s/article/Store-API-Accounts#creating
104
76
105
-
? Are you ready to continue? You may press any key to continue Yes
106
-
? What is the Client ID? xxxxxxxxxxxxx
107
-
? What is the Access Token? xxxxxxxxxxxxx
108
-
? What is the API Path? https://api.bigcommerce.com/stores/xxxxx/v3/
109
-
[2021-09-08T15:12:40.271Z] Successfully created your configuration, you're all set!
110
-
```
111
77
### Resetting configurations
112
78
113
79
If you need to reset the configurations, run the `widget-builder init` command to overwrite the existing assignments.
@@ -150,28 +116,3 @@ To publish a widget to your BigCommerce store, run the following command:
150
116
widget-builder publish [path to widget template]
151
117
```
152
118
153
-
## Contributions
154
-
155
-
If you wish to contribute, please refer to our [contribution guide](CONTRIBUTING.md)
156
-
and [code of conduct](CODE_OF_CONDUCT.md) for this project.
157
-
158
-
## Issues / Bugs
159
-
160
-
* Please include a clear, specific title and replicable description.
161
-
162
-
* Please include your environment, OS, and any exceptions/backtraces that occur. The more
163
-
information that is given, the more likely we can debug and fix the issue.
0 commit comments