dobefu/nuxtify_profile

Quickly build a decoupled Drupal site with Nuxt 3 and GraphQL

Maintainers

Details

git.drupalcode.org/project/nuxtify

Homepage

Source

Issues

Installs: 160

Dependents: 1

Suggesters: 0

Security: 0

Type:drupal-profile

1.0.0-beta1 2024-04-27 16:08 UTC

Requires

  • cweagans/composer-patches: ^1.7
  • drupal/admin_toolbar: ^3.4
  • drupal/entity_usage: ^2.0@beta
  • drupal/field_group: ^3.4
  • drupal/gin: ^3.0@RC
  • drupal/gin_login: ^2.0
  • drupal/graphql: ^4.7
  • drupal/graphql_compose: ^2.1@beta
  • drupal/graphql_compose_preview: ^1.0@beta
  • drupal/inline_entity_form: ^3.0@RC
  • drupal/jwt: ^2.0
  • drupal/key_auth: ^2.1
  • drupal/layout_paragraphs: ^2.0
  • drupal/menu_item_extras: ^3.0
  • drupal/metatag: ^2.0
  • drupal/pathauto: ^1.12
  • drupal/r4032login: ^2.2
  • drupal/restui: ^1.21
  • drupal/single_content_sync: ^1.4
  • drupal/string_field_formatter: ^2.0
  • drupal/user_registrationpassword: ^2.0
  • drush/drush: ^12.5
  • iconify/json: ^2.2

Requires (Dev)

GPL-2.0-or-later 43eeb9e09eed8b0e1731739f3f416bf709f0720c

This package is auto-updated.

Last update: 2024-05-04 15:22:09 UTC

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)

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. Create a new Composer project using the profile:

composer create-project "dobefu/nuxtify:main-dev"
  1. Navigate to the directory:
cd nuxtify
  1. Run the following commands to start DDEV and install the Drupal backend:
ddev start
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

Contributing

TODO

License

This project is licensed under the GNU General Public License version 2.0 (GPLv2). The GPLv2 is a widely used open-source license that grants users the freedom to use, modify, and distribute the code. It also ensures that any derivative works are also licensed under the GPLv2. However, it is important to note that the GPLv2 requires that any modifications or derivative works are also made available under the same license terms.

For more information about the GPLv2, please refer to the LICENSE file.