DruxtSite quickstart - ContentaCMS
One click, Fully Decoupled ContentaCMS Site starter-kit with Druxt.
DruxtSite connects Drupal to Nuxt via JSON:API to provide a framework for building a Fully Decoupled site.
This repostory provides a quickstart installation of:
- ContentaCMS
- Nuxt 2
- DruxtSite
Quickstart
Try it before you fork it:
Getting started
-
Click the Use this template button in GitHub and follow the on-screen instructions to Create a new repository.
-
Once the repository has been generated, open it in Gitpod by appending
https://gitpod.io#to the GitHub url.Example:
https://gitpod.io#github.com/druxt/quickstart-druxt-site-contentacmsNote: If this is your first time using Gitpod, you can signup for a free plan with your Github account.
-
Wait for your codebase to build.
Note: To speed up this step, enable Prebuilds by follow the instructions @ https://www.gitpod.io/docs/prebuilds#enable-prebuilt-workspaces
How to use it
Your environment contains a pre-install, pre-configured and running instance of ContentaCMS and Nuxt, with the DruxtSite module enabled.
You can access the services in your browser, via the Remote Explorer extension, or via the URL pattern: https://[PORT]-[GITPOD_ID].[GITPOD_SERVER].gitpod.io
Services
| Port | Service |
|---|---|
3000 |
Nuxt.js |
3003 |
Storybook |
8080 |
ContentaCMS |
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/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.