@appdirect/sfb-toolkit

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

Usage no npm install needed!

<script type="module">
  import appdirectSfbToolkit from 'https://cdn.skypack.dev/@appdirect/sfb-toolkit';
</script>

README

@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

Release Notes:

3.0.3

  • Bug fix: Fix PRODUCTS_LIST schema type not working on a custom page
  • Update sfb-toolkit package command to minify sfb-components.js bundle
  • Update sfb-theme-components library to version 0.0.245
    • Update custom components section in the Storybook documentation
  • Update @appdirect/sfb-theme-plaza to version 0.0.47 (sfb-theme-mp2@0.0.47)
    • Add product variants template
    • Add enableProductVariant theme setting

3.0.0

  • Add new storefront Header & Footer components
  • Add new menu manager in the Visual Editor
  • Update sfb-theme-components library to version 0.0.237 and the Plaza theme to meet WCAG 2.1 level AA for accessibility
  • Update @appdirect/sfb-theme-plaza to version 0.0.45 (sfb-theme-mp2@0.0.45)

2.0.15

  • Add new domain cross-selling page in Plaza theme. (See Documentation)
  • Read crossSellingEnabled setting from theme to optionally disable cross-selling
  • Update @appdirect/sfb-theme-plaza to version 0.0.44 (sfb-theme-mp2@0.0.44)

2.0.14

  • Fix npm security vulnerabilities when running sfb-toolkit storybook and sfb-toolkit components commands

2.0.13

2.0.10

  • Bug fix: sfb-toolkit storybook command throws an error

2.0.9

  • Update storefront-utils library

2.0.8

  • Improve the toolbar header view:
    • to preview the header as a regular user or a marketplace manager without a user token
    • to preview the header in the admin portal
  • The theme header-footer section can use assets (images, fonts) in the theme assets folder

2.0.7

  • Bug fix: Default props should be passed properly to custom components
  • Bug fix: Custom components do not work in Classic theme
  • Bug fix: Removing a null file when customComponents folder is created

2.0.6

  • Updating Classic and Plaza theme

2.0.5

  • Add new toolkit commands: storybook and components to build new custom components in your Plaza theme
  • Update setup and create commands to choose between a Classic or a Plaza theme

2.0.4

  • Update Classic theme, small fix in leads form
  • Update Plaza theme with product domains and bundles page

2.0.3

  • Add pricing content to add to cart mock
  • Add Support for Storefront Builder Components rendering
  • Bug fix: Fix Microsoft subscription upgraded rendering

2.0.2

  • Added Support for both SASS and SCSS styling file compilation
  • Bug fix: Hanging prompt on setup command on Windows

2.0.1

  • Documentation links updated
  • Bug fix: Footer custom JS script parsing

2.0.0

  • Classic Theme with new Checkout and Cart integration is now available (See Documentation)
  • Added Product Configuration page
  • Added Cart Preview
  • Added window function to add to cart AD_addToCart()
  • Standalone Domains now supports new Checkout
  • Bug fix: Windows CRLF now supported

1.1.0

  • Dynamic SASS compilation to work with Node 12

1.1.0

  • Toolkit is now ready and able to work on Node 12

1.0.0

  • Initial release

How to use

The idea behind Toolkit CLI is similar to how git CLI have been made. Developer can have multiple themes in 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 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 version Shows version of sfb-toolkit

Other Resources

This Repository is owned and maintained by Storefront Builder Team @ AppDirect Inc.