@appdirect/sfb-toolkit
v5.0.4
Published
Storefront Toolkit CLI to power up building your custom theme for AppDirect's Marketplace.
Downloads
195
Keywords
Readme
@appdirect/sfb-toolkit
Storefront Toolkit CLI to power up building your custom theme for AppDirect's Marketplace.
Requirements
- Node 10.x or 12.x for versions 1.x.x to 3.0.6
- Node 16.x or 18.x for versions 4.x.x or newer
Release Notes:
5.0.4
- updated UI library version to
[email protected]
- updated Plaza theme version to
[email protected]
How to use
The idea behind Toolkit CLI is similar to how git
CLI has been made.
Developers can have multiple themes in a single environment.
|Command|Description|
|---|---|
|sfb-toolkit setup
|Creates a new project/environment where Developer can store themes|
|sfb-toolkit create [name]
|Creates a new theme|
|sfb-toolkit checkout [name]
|Changes context to the theme [name]|
|sfb-toolkit about
|Lists existing themes|
|sfb-toolkit status
|Gives information about current configuration|
|sfb-toolkit update
|Update current theme's configuration|
|sfb-toolkit start
|Starts local server with current theme on https://localhost:3555/en-US/home
|
|sfb-toolkit package
|Creates a .zip file with current theme files|
|sfb-toolkit storybook
|[Deprecated] Start storybook for the currently selected theme|
|sfb-toolkit install [module]
|Installs npm module in the currently selected theme|
|sfb-toolkit components
|Setup custom components|
|sfb-toolkit components-info
|Custom components information|
|sfb-toolkit components-copy
|Copy UI library custom components|
|sfb-toolkit components-delete
|Delete copied UI library components|
|sfb-toolkit components-add
|Add a new custom components|
|sfb-toolkit import [themePath] [marketplacePath] [themeName]
|Imports a theme|
|sfb-toolkit version
|Shows version of sfb-toolkit|
Other Resources
This Repository is owned and maintained by UI Platform team @ AppDirect Inc.