nextjs-headless-wordpress: A JavaScript repository from imranhsayed

🎨 Next.js Headless WordPress

Headless WordPress, using Decoupled Architecture in Next.js
Backend in WordPress using WPGraphQL
Front end in React.

Features

Home Page, Blog Page, Post Page
Post Preview
Post Pagination.
Load More Posts.
SEO Component fetching data Yoast SEO with schema
Cypress for tests, Eslint for linting.
Apollo Client with GraphQL
Api endpoints.
Header and Footer in Next.js fetching from WordPress Menu items.
WordPress Widgets displayed on Next.js frontend.
Site title, tagline, copyright text, sourced from WordPress.
Next.js Image component, that has image optimization at request time.
Authentication with JWT and Http Only Cookie implementation.
Login feature for WP Post Preview in Next.js
Incremental Static (Re)generation and automatic creation of New Static post pages without having to re-build next.js the application.
Gutenberg styles support

Tutorial Course

Code for the tutorial is in the Tutorial Branch

Live Demo Link

https://nextjs-headless-wordpress-demo.vercel.app/

Setup

First clone/fork the repo and cd into it.

git clone https://github.com/imranhsayed/nextjs-headless-wordpress.git
cd nextjs-headless-wordpress

Install Docker from docs.docker.com/get-docker ( this step may not be required if you are using your own WordPress setup.)

It's very simple to setup the project with just one command and this ./nxtwp configure

One command project setup

The below command is going to set up the project in the interactive mode. It creates an .env file for front-end next.js project and setsup up frontend and/or backend. Run this from the root of the project.

./nxtwp configure

It's going to ask you a few of questions.

Q1. Do you already have a WordPress setup that you want to continue with? [y/n]:

Answer

y: If you would like to use this project's WordPress Docker setup ( In which case make sure to install and active all plugins from [backend/plugins-collection]) n: If you want to use your own WordPress setup.

Q2. ✍️  What is your WP backend URL? (defaults to http://localhost:8020):

Leave it blank if you would like to use this project's WordPress Docker setup, else enter your own WordPress site URL.

✍️  What is your frontend next js URL? (defaults to http://localhost:3000):

Leave this blank for development, as it will be the same as default for next.js

✍️  What is your Disqus comments shortname? (leave blank if you are not using):

Leave this blank if you are not going to use the Disqus comments, else enter your Disqus comments shortname.

This is going to automatically:

Creates the .env file in the frontend directory.
Setup WordPress backend with all the plugins via composer (if you chose y for the first question)
Install npm packages for next.js frontend and start development server.

WordPress Backend will be available on http://localhost:8020 Next.js Backend will be available on port http://localhost:3000

Make sure to activate all plugins that it has installed via composer.
Update block registry by going to WordPress Dashboard > GraphQL Gutenberg.
Update the permalink by going to Settings > Permalinks > Post name > Save
Copy the backend/wordpress/.htaccess file content into your WordPress .htaccess
For more information checkout the project Wiki

That's it!

During development

Useful commands: To be run from the root of the project.

./nxtwp configure       # Sets up backend and frontend and creates an .env file
./nxtwp start-all       # Creates and starts docker environment for WP and runs Next JS server
./nxtwp start-backend   # Creates and starts docker environment
./nxtwp start-frontend  # Installs all packages and Runs Next JS server
./nxtwp stop            # Stops the WordPress docker containers

Debugging

If you get 404 on frontend for graphql request, check to see that the .htaccess file in wordpress directory has the rules

# BEGIN WordPress
# The directives (lines) between "BEGIN WordPress" and "END WordPress" are
# dynamically generated, and should only be modified via WordPress filters.
# Any changes to the directives between these markers will be overwritten.
<IfModule mod_rewrite.c>
RewriteEngine On
RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization}]
RewriteBase /
RewriteRule ^index\.php$ - [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule . /index.php [L]
</IfModule>

# END WordPress

If front-end is throwing some other error.

Check if all the required WordPress plugins form backend/plugins-collection are active.
Ensure you have updated the block registry from WordPress backend > GraphQL Gutenberg
Ensure that .env file has correct env variables and their values in frontend/.env

References for Docker Images.

phpMyAdmin