Skip to main content

Getting Started

Prerequisites#

To develop your plugin, you need a Reach subscription. Preferably one where you're an owner (else you won't be able to publish your plugin).

If you don't have a subscription yet, you can create one for free.

Quick Start#

Use the Reach Plugin CLI to create your first plugin. Run the follwing command to get started:

npx @livetiles/create-reach-plugin <plugin-directory-name>

Please note that the target directory must be empty. The CLI will prompt you to choose between two plugin templates:

This will generate all files necessary to start developing your plugin.

To start the development server:

cd <plugin-directory-name>
npm run dev

Classic Plugin#

This will open a new tab in your browser where a new navigation node "Custom plugin" will be inserted into the left-side navigation of Reach. This node shows the contents of the HelloWorld.tsx file in <plugin-directory-name>/src

Embedded Plugin#

This will provide a new menu option inside the Page/Event/News editor once clicking Insert Object.

If you make any changes to the HelloWorld.tsx file, these will be rendered in the browser but you will need to manually reload the page to see the changes.

Note: for more information check the embedded plugins section.

The dev command ensures that any changes you make are only visible to you. Additional steps are needed to publish the changes. See the Publish Plugin Guide.