Video Tutorial - Building Extensions

Important

This feature is currently in Early Availability (EA) status. For more information, see our product lifecycle phases.

Prerequisites

Before you begin, you must have the following:

• Sign in to your marketplace as a Marketplace Manager.
• Familiarity with the command line and Node.js 18+ installed.

You must install the toolkit before you begin. Use the installation guide or the installation video for a walkthrough.

Toolkit installation (TL;DR)

1. Install the Toolkit globally:

npm install -g @appdirect/sfb-toolkit@latest

2. Run the guided setup (press Enter to accept defaults):

sfb-toolkit setup

Video Tutorial

Tips

1. Start your extension server from your own terminal for clearer logs and fewer interruptions.
2. Enable Developer Mode in /admin/extensions before testing locally; it expires every 8 hours per user.
3. Use the dev URL printed by npm run start (it includes devMode=true and appName) to load your extension in the marketplace.
4. Place static assets under static/assets and reference them with window.get_extension_assets('<filename>').
5. Run npm run build to generate the zip file you can upload in the extensions manager.