duffn/wordpress-wpgraphql-wpgatsby repository overview

⁠Gatsby Headless WordPress Starter

This is the fastest and easiest way to get a development environment up and running with headless WordPress and Gatsby.

This includes:

• WordPress⁠ - This is WordPress.
  • WPGraphQL⁠ - Provides a GraphQL schema for your WordPress site.
  • WPGatsby⁠ - Optimizes your WordPress site for Gatsby.
• wp-cli⁠ - The WordPress CLI for easily creating a new WordPress site.
• MySQL⁠ - You know, a database.
• Gatsby⁠ - A React-based open source framework for creating websites and apps.
  • gatsby-source-wordpress-experimental⁠ - The officially recommended way to use WordPress with Gatsby.

Note: This starter is meant for local development and evaluation purposes only.

⁠Installation

You must have git⁠, Docker⁠ and docker-compose⁠ installed on your machine.

This has been tested on macOS and it should work on Linux. I don't know about Windows.

Run either the automatic or manual installation below and visit http://localhost:8000⁠ for Gatsby and http://localhost:8001/wp-admin/⁠ for WordPress.

The default WordPress admin credentials are admin and secret.

⁠Automatically

bash -c "$(curl https://raw.githubusercontent.com/duffn/gatsby-headless-wordpress-starter/main/install.sh)"

⁠Manually

It's a good idea to download and review unknown scripts from the internet. So, you may want to clone this repository and run the script instead.

wget https://raw.githubusercontent.com/duffn/gatsby-headless-wordpress-starter/main/install.sh
# Review the script here.
bash install.sh

The script doesn't do anything besides check for required dependencies and run docker-compose, so you can just as well clone the repository and run docker-compose yourself.

git clone [email protected]/duffn/gatsby-headless-wordpress-starter
cd gatsby-headless-wordpress-starter
docker-compose up

⁠TODO

• Test on Linux.
• Test on Windows.
• Allow option for MariaDB as a database.

⁠License

MIT⁠