Gatsby Framework Guide
Introduction
Gatsby is a React-based framework with a built-in content layer that simplifies the process of integrating different sources of data. Gatsby provides a variety of rendering methods and has an extensive ecosystem of plugins and other integrations.
WordPress Requirements
Since Gatsby has its own built-in data layer, you’ll need to install a few other things to get started. In your WordPress site, install the following plugins:
In addition to these WordPress plugins, Gatsby also needs to install an npm package in the JavaScript application to finish the connection. Please reference the steps below.
Deploy Steps
To get started, you can run the following command to create a new Gatsby project and the follow the steps in their getting started guide:
npm init gatsby
During the installation process, you can select WordPress as a CMS option, and Gatsby will pre-install a few things for you.
Or, if you want to start with a blog template designed specifically for headless WordPress, you can clone this starter template:
git clone https://github.com/gatsbyjs/gatsby-starter-wordpress-blog
Install gatsby-source-wordpress Package
Both of the methods above will pre-install the gatsby-source-wordpress plugin, but you can manually install it using the following command:
npm install -save gatsby-source-wordpress
The gatsby-source-wordpress plugin completes the connection between your site and the Gatsby data layer. Consider reading Gatsby’s guide on getting started with WordPress for more details.
After you have created your application, cd into your project directory:
cd <your project directory>
Push Initial Commits to Your Repository
To deploy your project to our Headless Platform, it will need to be available on a remote GitHub, Bitbucket or GitLab repository. The Gatsby installation process initializes a local repository for the project.
Create a new remote repository, and then run the following commands to initialize and configure your local and remote repositories:
#Add remote repository
$ git remote add origin https://<your-git-provider>/<username>/<repo>
# Stage all changed files
$ git add -A
# Commit the files to the current branch
$ git commit -m "initial commit"
# Push changes to remote repository
$ git push -u origin main
Build Details
Since v5 of Gatsby requires Node.js v18, you will need to tell our Headless Platform to use a custom version of Node.js.å
To set a custom version of Node.js, use the engines field in the package.json file. For example, here is how to deploy your application Node.js 18.0.0:
"engines": {
"node": "18.0.0"
},To run Gatsby on our Headless Platform we’ll use the Gatsby CLI’s gatsby serve command, no adapter is needed. We will need to modify the start command that runs after building to listen on the correct port. Update the start script in package.json to look like this:
"start": "gatsby serve --port 3000"To commit these changes to your repository, run the following commands:
# Stage all changed files
$ git add -A
# Commit the files to the current branch
$ git commit -m "update build and start"
# Push changes to remote repository
$ git push -u origin mainDeploy Your Repository
Once your project is in your remote repository, you can follow the directions in our getting started guide to deploy your project to our Headless Platform.