Agility Gatsby Starter

Overview:

This product is a Gatsby project template that is designed to work with Agility CMS as the Content Management System. It provides a starting point for setting up a Gatsby project with all the necessary configurations and integrations for working with Agility CMS. The project includes features such as Gatsby V3, AgilityImage component, and the Agility CMS Gatsby Source Plugin. The template is deployed on Gatsby Cloud and Netlify.

Features:

• Gatsby V3 - the latest version of Gatsby’s core framework, providing improvements to the developer and user experience.
• AgilityImage - a custom image component that utilizes the Gatsby Image Plugin. It handles the display of responsive images stored within Agility CMS, following best practices for performance.
• Agility CMS Gatsby Source Plugin - an official Gatsby plugin that refreshes content only if it has changed since the last build, ensuring fast builds regardless of the number of pages.

Installation:

To install and set up this Gatsby project template with Agility CMS, follow these steps:

Prerequisites:

• Install the Gatsby CLI
• Sign up for a Free Agility CMS Account
• Retrieve your Agility CMS API Credentials

1. Clone this repo to your local machine.
2. Install Node dependencies using NPM.
3. Configure your local environment:
   • Rename ./.env.development.example to ./.env.development.
   • Add your development AGILITY_GUID and AGILITY_API_KEY variable values in .env.development.
   • Rename ./.env.production.example to ./.env.production.
   • Add your production AGILITY_GUID and AGILITY_API_KEY variable values in .env.production.
4. Start the Gatsby development server:
   • Using NPM, run the command to launch the local development server.

To build a production version of the project and test it locally:

1. Build the production version using NPM.
2. Deploy the project either with Vercel or Netlify.

Summary:

This Gatsby project template serves as a starting point for creating a Gatsby project integrated with Agility CMS as the Content Management System. It includes features such as Gatsby V3, AgilityImage component, and the Agility CMS Gatsby Source Plugin. The template provides easy setup and configuration steps, allowing developers to quickly start working on their Gatsby project with Agility CMS.