Setup

DrupalX Project Setup

DrupalX is a flexible framework designed to empower developers in creating tailored solutions for their organizations. This guide will walk you through the essential steps to set up your project using the DrupalX project template.

Getting Started

1. Export Your Configuration

Begin by exporting your configuration to the ./config/sync directory. This step is crucial for maintaining consistency across environments.

ddev . drush cex -y

After this step, you have full control over all configuration aspects. To install your site using this exported configuration:

ddev . drush si -y minimal --existing-config

Note: This command installs your configuration without including any demo content.

2. Manage Composer Dependencies

The DrupalX Composer setup includes several pre-configured dependencies. You can customize these based on your project needs:

  1. First, uninstall any modules you don't require.

  2. Then, remove the corresponding dependency from your project's composer.json file.

This approach ensures a clean and efficient project structure.

Project Structure

DrupalX follows a modular architecture. Key directories include:

  • ./config/sync: Stores your exported configuration

  • ./web: Contains the Drupal core files

  • ./modules/custom: For your custom modules

  • ./themes/custom: For your custom themes

Best Practices

  • Regularly export your configuration to keep ./config/sync up-to-date.

  • Use version control (e.g., Git) to track changes in your configuration and custom code.

  • Leverage DDEV commands for consistent local development environments.

Troubleshooting

If you encounter issues during setup:

  1. Ensure all DDEV containers are running correctly.

  2. Verify that your composer.json file is valid and all dependencies are properly installed.

  3. Check the Drupal error logs for any specific error messages.

Next Steps

Now that you've set up your DrupalX project, lets explore the DrupalX approach to frontend development with Next.js. This integration allows for a powerful, decoupled architecture that can significantly enhance your site's performance and user experience.

Last updated