Skip to main content

Add-ons

Drupal Umami Demo Data Add-on​

This add-on adds necessary components and routes to your Pantheon Decoupled Kit Next.js Starter Kit to display data from Drupal's Umami demo site. This includes a routes for all individual recipes, as well as an index page with a grid which displays all recipes.

Before You Begin​

  • Create a Drupal site with our Backend Starter. Use the "Installing with Umami Demo Data" section to ensure you have the correct dataset
  • Familiarize yourself with the Create Pantheon Decoupled Kit CLI. Any package manager can be used with the CLI [npm, pnpm, yarn].

Usage​

Adding the next-drupal-umami-addon to an Existing Project​

  1. Use the create command to initiate the cli with the next-drupal-umami-addon generator
    # set the `outDir` to the root directory of your existing Next Drupal Starter
    npm create pantheon-decoupled-kit next-drupal-umami-addon --outDir ./my-app-dir
  2. Follow the terminal prompts, accept the project diff changes
  3. Start your project locally and observe the new related content section that displays at the bottom of post detail pages

Building a New Project with the next-drupal-umami-addon​

  1. Use the create command to initiate the cli with both the next-drupal and next-drupal-umami-addon generators
    npm create pantheon-decoupled-kit next-drupal next-drupal-umami-addon
  2. Continue through the prompts until all actions finish running
  3. Start your project locally. Observe the new related content section that displays at the bottom of post detail pages

Drupal Search API Add-on​

This add-on adds necessary components and routes to your Pantheon Decoupled Kit Next.js Starter Kit to query the Drupal Search API and display its response. This includes the addition of a search bar component and dedicated search results page.

Before You Begin​

Usage​

Adding the next-drupal-search-api-addon to an Existing Project​

  1. Use the create command to initiate the cli with the next-drupal-search-api-addon generator
    # set the `outDir` to the root directory of your existing Next Drupal Starter
    npm create pantheon-decoupled-kit next-drupal-search-api-addon --outDir ./my-app-dir
  2. Follow the terminal prompts, accept the project diff changes
  3. Start your project locally. Observe the new search input in the site header along with added content under the /search route

Building a New Project with the next-drupal-search-api-addon​

  1. Use the create command to initiate the cli with both the next-drupal and next-drupal-search-api-addon generators
    npm create pantheon-decoupled-kit next-drupal next-drupal-search-api-addon
  2. Continue through the prompts until all actions finish running
  3. Start your project locally. Observe the new search input in the site header along with added content under the /search route