Skip to main content

Plugin creation and setup

To start developing a Strapi plugin, you need to:

  1. create the plugin,
  2. enable the plugin,
  3. install dependencies, build the admin panel, and start the server(s).
☑️ Prerequisites

You created a Strapi project.

Use the CLI to create a project:

Run the corresponding command in a terminal window, replacing my-project with the name of your choice:

yarn create strapi-app my-project --quickstart

More details can be found in the CLI installation guide.

Create the plugin using the CLI generator​

The fastest way to create a Strapi plugin is to use the CLI generator. To do so:

  1. Navigate to the root of an existing Strapi project, or create a new one.

  2. Run the following command in a terminal window to start the interactive CLI:

      yarn strapi generate plugin

  3. Choose either JavaScript or TypeScript for the plugin language.

🚧 Experimental plugin CLI

Strapi now also offers a plugin CLI, but use it at your own risk as it's still experimental.

Enable the plugin​

Once the strapi generate plugin CLI script has finished running, the minimum required code for the plugin to work is created for you, but the plugin is not enabled yet.

To enable a plugin:

  1. If it does not exist already, create the plugins configuration file file at the root of the Strapi project.

  2. Enable the plugin by adding the following code to the plugins configuration file:

    ./config/plugins.js
    module.exports = {
      // ...
      "my-plugin": {
        // name of your plugin, kebab-cased
        enabled: true,
        resolve: "./src/plugins/my-plugin", // path to the plugin folder
      },
      // ...
    };
💡 Tip

If you plan to use the plugin outside the Strapi project it was created in, move your plugin file outside the Strapi project and change the resolve value to the absolute directory path of your plugin.

Install dependencies, build the admin panel, and start servers​

Once the plugin code has been generated and the plugin is enabled, the next steps slighly differ depending on whether you created a vanilla JavaScript-based plugin or a TypeScript-based plugin (see step 3 of the CLI generator instructions).

  1. Navigate to the folder of the plugin.
    If created from a Strapi project using the CLI generator, plugins are located in the src/plugins folder (see project structure).

  2. Run the following command in the newly-created plugin directory to install plugin dependencies:

    yarn

  3. Navigate back to the Strapi project root with cd ../../.. and run the following command to build the admin panel and start the server(s):

    yarn develop

You should now be ready to start developing your plugin.

🤓 What to read next?

You can either jump to the plugin structure documentation or read the servers and hot reloading section to learn more about different ways to start the server.

Servers and hot reloading​

Strapi itself is headless . The admin panel is completely separate from the server.

The server can be started in 2 different ways: you can run the backend server only or start both the server and admin panel servers.

Start only the backend server​

To start only the backend server, run the following command:

yarn develop

This will run the server on localhost:1337 and enable hot reloading only on the back-end server, i.e. it will only auto-reload when changes are made to the server. If you are only doing development in the ./server directory of your plugin, this will be faster.

Start both the backend and admin panel servers​

If you are doing development on both the /server and /admin directories of your plugin, run the following command:

yarn develop --watch-admin

This will run the server on localhost:1337 and enable hot reloading on both the back-end and front-end servers, i.e.it will auto-reload when changes are made to the server or the admin panel of Strapi.