Skip to main content

Quickstart

๐Ÿฃ Write your Managed Componentโ€‹

  1. Scaffold a new managed component project by running
    npm init managed-component
    Following the commandline setup wizard will result in a new folder in your current directory that contains a few key ingredients to get started writing your new managed component. It's pre-configured with:
  2. Add the content of your managed-component within the src/index.ts file of your newly created project.
    export default async function (manager, settings) {
    // the Managed Component logic goes here
    }
  3. Build your component with
    npm install
    npm run build

๐Ÿงช Test your Managed Componentโ€‹

Test your component with a Component Manager, such as the open-source WebCM.

๐Ÿ’Œ Share your Managed Componentโ€‹

Let the community know about your managed component by making a PR to these docs so it can be shared in the Known Components list.