Installation

Project Codebase

DrupalX is a distribution built upon the popular drupal-composer/drupal-project template, providing a robust foundation for decoupled Drupal projects.

Getting Started

Initialize Your Project

Use Composer to create your project:

composer create-project drupalninja/drupalx-decoupled:10.x-dev drupalx-decoupled-10x --no-interaction

After running this command, review the generated composer.json file to understand the project's structure and dependencies. All contributed modules and themes are managed through Composer for easy modifications and updates.

The DrupalX project includes pre-configured recipes in the docroot directory, which will be automatically installed when you run the custom ddev install command.

Quick Install

DrupalX installation demo

DrupalX uses DDEV as the default development environment to ensure consistent setup across different machines.

1. Configure DDEV

   Run the DDEV configuration:

   ddev config

   This command sets up the necessary DDEV configuration for your project.

2. Install DrupalX

   Execute the custom install command to:

   • Start DDEV

   • Install Composer dependencies

   • Install DrupalX content and configuration

   Run:

   ddev install

   Once installation is complete, you'll see a login URL in the console output. Use this URL to access your new DrupalX site and verify that the Drupal site installed correctly.

3. Prepare Next.js Application

   Navigate to the ./nextjs/ directory in your docroot. DrupalX uses a monorepo approach for simplicity. Your application should already have the correct environment variables from the DrupalX installation. In the Next.js directory, run:

   nvm install
   npm install
   npm run dev

   This will launch your application. Verify that the Next.js application loads as expected. Once this is working, your Next.js preview will also work inside the Drupal admin.

Troubleshooting

If you encounter any issues during the installation or setup process, please report them on the GitHub project's issue tracker.

Next Steps

Congratulations on completing the installation of your DrupalX project! Now that your project is set up, it's time to configure and customize it to suit your needs.