Skip to main content

Get Started

This page provides all the steps needed to create your first extension. It covers the following tasks:

  1. Install Fynd Development Kit (FDK) command-line interface (CLI)
  2. Generate starter code for extension
  3. Populate test data
  4. Preview your extension

Prerequisites​

Before getting started, you'll need the following:


1. Install FDK CLI​

The FDK CLI simplifies theme and extension development using commands for creating, testing, and deploying projects. For more details, refer to the GitHub documentations.

  • Run the following command in your terminal to install FDK CLI:
npm install -g @gofynd/fdk-cli
note

You can run fdk --version to check if FDK CLI is successfully installed.


2. Generate the Starter Code​

  1. Run the following command to log into your Fynd Partner account:
fdk login
  1. Select the account for which you want to create the extension.
note

After login, you can run fdk user to verify if you've logged in.

  1. Go back to your terminal and run the following command to initialise a new extension:
fdk extension init
  1. Select Create new extension.

  1. Enter a name for your extension.

  2. Select the extension type as Public.

  3. Select your preferred technology stack for the template.

info

The fdk extension init command creates the extension's folder in your local system with a starter code and registers the extension in the Fynd Partner's account you selected during fdk login. The starter code includes pre-implemented OAuth flow and an easy setup for webhooks.


3. Populate Test Data​

  1. Run the following command to navigate to the extension directory:
cd "<extension-name>"
  1. Run the following command:
fdk populate
  1. Select your development company.

note

The fdk populate command adds a predefined set of products to the selected development company. This can be done only once per development company. However, if preferred, you can also create the products manually.


4. Preview Your Extension​

  1. Run the following command:
fdk extension preview
  1. Copy the preview URL from your terminal into the browser.

  1. Click Accept and Continue. You should see the following screen:
🏆Congratulations!

You've successfully created and launched your first extension.

Futher reading

You can now start building your extension features using the below resources:


Was this section helpful?