DruxtJS demo Drupal JSON:API backend.

This is the Drupal 9 codebase for the JSON:API backend used by the DruxtJS demonstration site.

This codebase is derived from the amazeeio/drupal-example-simple template.

Requirements

• docker

• pygmy gem install pygmy (you might need sudo for this depending on your Ruby configuration)

OR

• Lando

Local environment setup - pygmy

1. Checkout this project repo and confirm the path is in Docker's file sharing config - https://docs.docker.com/docker-for-mac/#file-sharing

   git clone https://github.com/druxt/demo-api.druxtjs.org.git demo-api.druxtjs.org && cd $_

2. Make sure you don't have anything running on port 80 on the host machine (like a web server) then run pygmy up

3. Build and start the build images:

   docker-compose up -d
   docker-compose exec cli composer install

4. Visit the new site @ http://demo-api-druxtjs-org.docker.amazee.io

• If any steps fail, you're safe to rerun from any point. Starting again from the beginning will just reconfirm the changes.

Local environment setup - Lando

This repository is set up with a .lando.yml file, which allows you to use Lando instead of pygmy for your local development environment.

1. Install Lando.

2. Checkout the project repo and confirm the path is in Docker's file sharing config - https://docs.docker.com/docker-for-mac/#file-sharing

   git clone https://github.com/druxt/demo-api.druxtjs.org.git demo-api.druxtjs.org && cd $_

3. Make sure you have pygmy stopped. Run pygmy stop to be sure.

4. We already have a Lando file in this repository, so we just need to run the following command to get Lando up:

lando start

5. Install your Drupal site with Drush:

lando drush si -y

6. And now we have a fully working local Drupal site on Lando! For more information on how to deploy your site, check out our documentation or our deployment demo.