An opinionated setup to start a headless or decoupled ContentaCMS (Drupal) backend with a GatsbyJS front end. Uses the wonderful Drupal Umami example profile to show how GatsbyJS can parse data using GraphQL on the front end from the JSON:API (which is now part of Drupal core as of 8.7.0) and generate a blazing fast static site.
The purpose of this setup is to simulate a two server setup with separate containers for the Gatsby instance and the Drupal instance and separate URLs http://gatsby.contenta.docksal and http://contenta.docksal. This makes for a portable setup that can be used across front and backend teams whether they share a codebase of if they are separate.
This project requires Docksal and whatever Docker flavor you choose (Docker for Mac, VirtualBox, etc.).
- Clone this repo to your local machine.
- Ensure that Docksal is installed.
- Run
fin initfrom the project root.- This will destroy any existing containers and volumes.
- Wait while Drupal installs and a static version of your Gatsby site is generated.
- Once
fin initfinishes doing the things, you can visithttp://contenta.docksalto view the Drupal backend orhttp://static.contenta.docksalto view the static site that was generated. If you wish to run the Gatsby development server, runfin gatsby-devto start a development server that you can visit athttp://gatsby.contenta.docksal. - To rebuild the static site, run
fin gatsby-buildand your site will be generated.
Currently, this is used only for demo purposes or as a starter kit to begin a project. Once you clone to your local, delete the .git folder from the project root and do what you want with it. Get weird if you want, I won't judge.
- Drupal - Backend base
- ContentaCMS - Drupal distribution for rapid decoupled setup
- Composer - Drupal and PHP package management
- NodeJS - Frontend serving and NPM modules
- GatsbyJS - Frontend building and static site generator
Please contribute. Fork early, fork often, and submit those PRs, people!
This project is licensed under the MIT License - see the LICENSE.md file for details
- Heavily inspired by The Gatsby Drupal Example
- Docksal for putting together an awesome local dev environment built on Docker
- ContentaCMS for making a great Drupal distro to make decoupled that much easier
- GatsbyJS for being blazing fast and keeping everything easy to load
- Everyone whose code I borrowed and bastardized to make this a thing
- Sean Dietrich for putting up with all of my questions
- Get PR approved to Docksal to make it easier to run the non-cli container commands.
- Allow the Node/Gatsby container to use Unison or similar for watching file changes where applicable.
- TBD