Help Center

Menu

Create component package file structure

A component is made up of configuration and JavaScript files, which the Component Service uses to render the front end of your component, as well as the editing experience.

Before you start

Read File structure for an explanation about the core component files and their purpose:

  • manifest.json

  • main.cjs

  • README.md

  • preview-wrapper.html

Steps

  1. Create a directory called components.

  2. Inside the components directory, create a directory named after your component, for example, hello-world.

  3. Within the hello-world directory, create the following empty files:

    • manifest.json

    • main.cjs

    • README.md

    • preview-wrapper.html

You can initialize this components directory as a GIT repository and store a collection of components (such as this hello-world component) in one repo.

For now, continue to the next step of the tutorial.