Druxt Quickstart

One click, fully Decoupled Drupal with DruxtJS.

Druxt Quickstart provides a Drupal and Nuxt mono-repo to get you started with DruxtJS power decoupled Drupal development.

This repository includes:

• Drupal 11
• Nuxt 2
• Druxt 1

Quickstart

npx giget@latest gh:druxt/quickstart#develop my-druxt-site --install
cd my-druxt-site
npm run dev

--install runs the full setup automatically: frontend, Composer, and a local Drupal 11 + SQLite backend. Needs PHP 8.4 and Composer on PATH. Without them, it installs the frontend only and prints the next steps.

Theme branches

Start quicker with a pre-installed UI Framework.

• BootstrapVue
• TailwindCSS

Getting started

Requires Node 16 and one of:

• PHP 8.4 (with the pdo_sqlite extension) + Composer on your machine (Drush comes with the backend - no global install needed), or
• DDEV (Docker)

nvm or mise users: nvm use / mise install provides the pinned versions.

One-command setup (local PHP + SQLite, no Docker)

1. Create your repository from this template (or clone it), then from the repository root:

   npm run setup

   This installs the frontend dependencies, provisions Drupal with Druxt, Simple OAuth and an OAuth Consumer (SQLite, throwaway), starts the backend, and writes BASE_URL + OAUTH_CLIENT_ID to .env.

   make setup works too, as do make dev, make login, make info, make reset, etc.

2. Start developing:

   npm run dev

   • Drupal backend: http://127.0.0.1:8888
   • Nuxt frontend: http://localhost:3000
   • One-time Drupal login: npm run login

npm run dev and npm run start automatically start the local backend if it is not already running, and leave external backends alone.

Other commands: npm run stop, npm run reset (fresh site), npm run info, npm run login, npm run devtools -- <script> for direct access to drupal/.devtools/. See drupal/.devtools/README.md for what each backend script does.

Local development with DDEV

Using DDEV? Keep BASE_URL as the *.ddev.site URL in .env (cp .env.example .env gives you that). Then:

1. Frontend (from repository root):

   npm run setup

   Detecting the DDEV BASE_URL, this installs the frontend only and prints the backend steps.

2. Backend (from drupal/):

   ddev start
   ddev drupal-install
   ddev druxt-add-consumer

   druxt-add-consumer prints OAUTH_CLIENT_ID=... - copy it into .env.

3. npm run dev as above. The DDEV backend is never auto-started or auto-stopped from the npm scripts.

Development Container (VS Code, Codespaces, DevPod)

.devcontainer/devcontainer.json gives you a ready environment: Node 16, PHP 8.4, Composer, and mise (config pre-trusted), provisioned through drupal/.devtools (PHP built-in server + SQLite) - no Docker-in-Docker needed.

Tool	How
VS Code	Clone, open the folder, run Dev Containers: Reopen in Container
GitHub Codespaces	On the repository page: Code → Open with Codespaces
DevPod	Click the badge above, run devpod up https://github.com/druxt/quickstart (CLI), or add the same URL as a workspace source in DevPod's desktop app - all three read this same devcontainer.json, no extra config needed

First open runs npm install at the repository root, which triggers the same full setup pipeline as Quickstart above: frontend dependencies, Composer, a provisioned Drupal backend, and the backend started and ready. Then:

npm run dev

• Drupal backend: http://127.0.0.1:8888
• Nuxt frontend: http://localhost:3000

How to use it

Your environment contains a pre-installed, pre-configured and running instance of Drupal and Nuxt, with the DruxtSite module enabled.

In a Development Container (VS Code, Codespaces, DevPod), forwarded ports are accessible via your editor's Ports panel, or Codespaces' own URL pattern for forwarded ports.

Services

Port	Service
3000	Nuxt.js
3003	Storybook
8888	Drupal (local .devtools backend - DDEV serves at its own *.ddev.site URL instead)

Tools

DDEV

DDEV is an open-source tool that makes it dead simple to get local PHP development environments up and running within minutes.

DDEV is used to manage the Drupal instance, and provides a CLI that can be used to run common drupal tasks, including ddev drush.

These commands should be run from within the /drupal folder.

Refer to the documentation for more details: https://ddev.readthedocs.io

@nuxtjs/auth-next

Zero-boilerplate authentication support for Nuxt.js!

The @nuxtjs/auth-next module is installed and configured to connect to the Drupal Simple OAuth module by way of the DruxtAuth module:

this.$auth.loginWith('drupal-authorization_code')

• More details on how to use the $auth service can be found at https://auth.nuxtjs.org/api/auth

@nuxtjs/storybook

Storybook integration with NuxtJS .

Druxt integrates with the Nuxt Storybook module to provide zero-configuration, auto-discovery stories with access to live data from your Drupal backend.

To start Storybook, navigate to the nuxt directory and run npx nuxt storybook.

License

MIT