@appdirect/sfb-toolkit

Storefront Toolkit CLI to power up building your custom theme for AppDirect's Marketplace.

Theming a template leverages Nunjucks Template System to keep Server Side Rendering. It can be easily mixed with eg. HTML, CSS, JavaScript, jQuery, SASS.

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.0

• Added sfb-toolkit import command
• Added sfb-toolkit components-add command
• Added sfb-toolkit components-copy command
• Added sfb-toolkit components-delete command
• Updated @appdirect/sfb-theme-plaza to version 0.0.82 (sfb-theme-plaza@0.0.82)

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

• Official Documentation
• Checkout Integration
• Video Tutorials
• Nunjucks Template System Documentation
• Contact Support

This Repository is owned and maintained by UI Platform team @ AppDirect Inc.