dobefu/nuxtify

Quickly build a decoupled Drupal site with Nuxt 3 and GraphQL

1.0.0-beta1 2024-04-28 18:00 UTC

Requires

• composer/installers: ^2.0
• cweagans/composer-patches: ~1.0
• dobefu/nuxtify_profile: ^1.0@beta
• drupal/core-composer-scaffold: ^10.2
• drupal/core-recommended: ^10

Requires (Dev)

• drush/drush: ^12.4

Conflicts

• drupal/drupal: *

GPL-2.0-or-later

• Connor van Spronssen

README

This project serves as a quickstart profile for integrating Drupal and Nuxt 3, allowing them to communicate with each other. It provides a foundation for building dynamic and interactive web applications.

Table of Contents

• Installation
  • Backend (Drupal)
  • Frontend (Nuxt)
• Usage
• Contributing
• License

Installation

Backend (Drupal)

To install the Drupal backend for this project, you can use DDEV, a local development environment tool. Follow the steps below:

1. Make sure you have DDEV installed on your system. If not, you can install it by following the instructions in the DDEV documentation.

2. Once DDEV is installed, navigate to the project directory in your terminal:

cd nuxtify

1. Run the following command to install the Drupal backend:

ddev install -y

This command will automatically set up the necessary dependencies and configurations for the Drupal backend.

1. After the installation is complete, you can launch the local website with the following command:

ddev launch

Frontend (Nuxt)

To set up the frontend (Nuxt) for this project, you will need to have Node.js installed on your system. Make sure to use the version that is in the .nvmrc file.

NVM can be used to manage Node.js versions. Install NVM by following the instructions in the NVM GitHub repository. Once NVM is installed, you can run nvm use in the frontend directory to use the correct version automatically.

1. Run the following command to install dependencies:

make install

Usage

To run the frontend locally, run the following command:

make watch

To check the frontend code for linting errors, run the following command:

make lint

To build the project, run the following command:

make

License

The project is licensed under the MIT License, which is a permissive open-source license. This means that you are free to use, modify, and distribute the code for both commercial and non-commercial purposes. The license also comes with limited liability and warranty, so use the code at your own risk. For more details, please refer to the LICENSE file.