Authors:
Cameron Johns, Cille Schliebitz, Anita Gu
Changed on:
3 Feb 2025
This lesson provides a step-by-step guide to downloading, installing, and setting up a new Component SDK project. You'll learn how to prepare your development environment, install necessary dependencies, and run the project locally. We'll also cover the crucial step of referencing your local plugin within your Fluent Web Apps manifest, enabling you to integrate your custom components into your applications.
`omx-component-sdk`
`Hello.tsx`
`fc.mystique.manifest.store`
In this lesson, you will follow the steps to download the Component SDK and set up a new Component plugin project.
Complete the steps below:
This video explains how to extract the ZIP folder
The Component SDK is a React-based web project that uses the yarn package manager.
Watch the following video to complete the steps below to install the Component SDK:
`omx-component-sdk`
`yarn install`
`omx-component-sdk`
`Hello.tsx`
`yarn start`
This video explains how to install Yarn
To use your plugin in a Fluent Web App, you can add a reference to your local plugin project running on localhost to your manifest file.
You should also have the Fluent Store main manifest overridden in your account, as this was used in the UX Framework course.
Open the
`fc.mystique.manifest.store`
`{`
` "type": "url",`
` "src":"http://localhost:3001/"`
`}`
This video explains how to update the manifest
Copyright © 2025 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.