feat(#458): Add DruxtAuth to DruxtSite example

.gitpod.yml

@@ -19,8 +19,11 @@ tasks:
       cd $GITPOD_REPO_ROOT/docs/nuxt && yarn
       cd $GITPOD_REPO_ROOT && yarn build:docs
     command: |
+      # Setup Gitpod .env
+      $GITPOD_REPO_ROOT/.gitpod/scripts/env-setup.sh
+
       # Start Drupal
-      cd $GITPOD_REPO_ROOT/docs/drupal && ddev start -y && ddev drush uli
+      cd $GITPOD_REPO_ROOT/docs/drupal && ddev start -y && ddev gitpod-config && ddev drush uli
 
       # Display welcome message
       cd $GITPOD_REPO_ROOT && cat .gitpod/WELCOME.md

.gitpod/WELCOME.md

@@ -11,7 +11,8 @@
 To get started you can do one of the following tasks:
 - Run the Druxt build tools: `yarn build --watch`
 - Run the Druxt test suite: `yarn test --watch`
-- Generate Druxt documetation: `yarn build:docs`
+- Generate Druxt documentation: `yarn build:docs`
+- Start an example DruxtSite: `yarn example:druxt-site`
 - Start the DruxtJS.org website: `cd docs/nuxt && yarn dev`
 
 Happy contributing.

.gitpod/scripts/env-setup.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -eu -o pipefail
+
+echo -en "OAUTH_CALLBACK=https://3000-${GITPOD_WORKSPACE_ID}.${GITPOD_WORKSPACE_CLUSTER_HOST}/callback" > $GITPOD_REPO_ROOT/docs/.env

CONTRIBUTING.md

@@ -29,6 +29,40 @@ If you are able to resolve an issue, or have improvements you would like to prop
 
 * * *
 
+## Example projects
+
+The Druxt monorepo contains a collection of example projects inside the aptly named "examples/" directory.
+
+All projects are connected to the locally built codebase and should be used for testing during development.
+
+All examples use the Drupal instance located @ `docs/drupal` (`cd docs/drupal && ddev start && ddev drupal-install`).
+
+### Custom module
+
+This a a bare bones example of a custom DruxtModule.
+
+`cd examples/custom-module && yarn && yarn dev`
+
+### DruxtSite
+
+This is an example of a basic, un-themed DruxtSite with support for authenticated users.
+
+`yarn example:druxt-site`
+
+### Entity form
+
+A basic contact form example of the DruxtEntityForm component.
+
+`cd examples/entity-form && yarn && yarn dev`
+
+### Node client
+
+A non-Nuxt example, using the DruxtClient in a basic node app.
+
+`cd examples/node-client && yarn && yarn dev`
+
+* * *
+
 ## Development tools
 
 The Druxt repository is setup with tools and automated processes to help with development and to ensure a maintainable project:

docs/.env

@@ -0,0 +1 @@
+OAUTH_CALLBACK=http://localhost:3000/callback

docs/drupal/.ddev/commands/web/drupal-install

@@ -6,3 +6,4 @@
 
 composer install
 drush -y tome:install
+drush cache:rebuild

docs/drupal/.ddev/commands/web/gitpod-config

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+## Description: Update Gitpod configuration in Drupal
+## Usage: gitpod-config
+## Example: "ddev gitpod-config"
+
+# Update the Consumer redirect URL.
+drush php-eval '
+$consumer = \Drupal::service("entity.repository")->loadEntityByUuid("consumer", "1a6b8816-26de-4b70-bcdf-919600542f03");
+$consumer->redirect = getenv("OAUTH_CALLBACK") ?: "http://localhost:3000/callback";
+# var_dump($consumer->redirect->value);
+$consumer->save();
+'
+
+# Rebuild cache.
+drush cache:rebuild

docs/drupal/.ddev/docker-compose.env.yaml

@@ -0,0 +1,8 @@
+version: '3.6'
+
+services:
+  web:
+    env_file:
+      - "$PWD/../.env"
+    volumes:
+      - "$PWD/../.env:/var/www/html/.env"

docs/drupal/composer.json

@@ -24,6 +24,7 @@
         "drupal/decoupled_router": "2.0.3",
         "drupal/druxt": "^1.1.1",
         "drupal/jsonapi_hypermedia": "^1.6",
+        "drupal/simple_oauth": "^5.2",
         "drupal/tome": "^1.6",
         "drush/drush": "^11.0"
     },