nerkarso / directus-extensions

Collection of Directus extensions
https://nerkarso.github.io/directus-extensions/
10 stars 2 forks source link
directus directus-extension

Banner

Directus Extensions

Collection of Directus extensions.

Available Extensions

Bundles

Displays

Endpoints

Hooks

Interfaces

Operations

Themes

Installation

  1. Open the terminal in your Directus project.
  2. Install the extension:
npm install directus-extension-<extension-name>

Creating

The easiest way to start developing extensions is to use the create-directus-extension utility:

pnpx create-directus-extension

After specifying the name of the extension, the type of the extension and the programming language you want to use, the utility will create a folder with the recommended file structure to create an extension.

Developing

Use the watch script when developing your extension because it rebuilds your source code whenever a file has changed.

pnpm watch

Building

Before your extension can be used by Directus, it has to be built. If you used the create-directus-extension utility to scaffold your extension, building your extension is as easy as running:

pnpm build

Publishing

  1. Increment the version number in the package.json file.

  2. Build the package:

pnpm build
  1. Publish the package:
npm publish --access=public