Pantheon Decoupled Kit Next Drupal Starter

There are two ways to get started with the Next Drupal Starter:

Option 1: Use create-next-app

1. In your terminal, run the following command:

npx create-next-app -e https://github.com/pantheon-systems/next-drupal-starter --use-npm

2. Follow the prompts in your terminal to complete the setup.

Option 2: Clone the repo

1. Clone this repo:

git clone git@github.com:pantheon-systems/next-drupal-starter.git

2. Install node modules

cd next-drupal-starter && npm install

For either option, create a .env.development.local file and update it with the following: (See .env.example for an example)

BACKEND_URL=
IMAGE_DOMAIN=

# Used to set the debug mode for the DrupalState store(s)
# If not set, debug mode for the store(s) is set to false
DEBUG_MODE=

# this value can also bet set in the command line
# before running commands for example
# FRONTEND_URL=example.com npm run build
FRONTEND_URL=

# These variables are needed to enable Preview
PREVIEW_SECRET=
CLIENT_ID=
CLIENT_SECRET=

4. Run lando start

5. Open a browser and navigate to http://drupalnext.lndo.site/.

Pantheon @pantheon-systems/drupal-kit

The Pantheon @pantheon-systems/drupal-kit is included as a dependency in this project. This allows developers to make use of utility functions to simplify the process of building and maintaining a decoupled site on Pantheon, including:

• addSurrogateKeyHeader()
• updateMaxAge()

Full documentation can be found at: https://github.com/pantheon-systems/decoupled-kit-js/tree/canary/web/docs/Packages/drupal-kit

Example Pages

• examples/auth-api - a simple example that sources data from an endpoint that requires authorization.
• examples/pagination - an example that sources paged data from JSON:API and paginates it client side.

Customizing the Starter

The pages/recipes directory can be safely removed if you are using a Drupal instance that does not source the Umami demo data

For a guide on creating your first Next Drupal customization, see Your First Drupal Customization

Tests

Tests are written with vitest. All new functionality should have unit tests or snapshot tests where applicable.`

Any fetch calls should be mocked with msw in setupFile.js

There are two data profiles to test against: the Umami profile and the Default profile. These profiles are available as Drupal modules and contain data to render the frontend with. See our Backend Starters for more information on setting up a Drupal instance.

Commands

This section assumes the package manager in use is npm. If you are not using npm, replace npm with the name of your package manager. To run the tests for both profiles sequentially:

npm test

To run the test for a single profile:

# test against the umami profile data
npm run test:umami
# tests against the default profile data
npm run test:default