Want to learn about why Agility CMS + Gatsby? is a match made in heaven?
This project is meant to be used with our Blog Template, and is a great starting point to get a Gatsby project up and running quickly with Agility CMS as the Content Management System.
- Gatsby V3 - The latest version of Gatsby’s core framework which introduces massive improvement to the developer and user experience.
- AgilityImage - A custom image component utilizing the new Gatsby Image Plugin that take's images stored within Agility CMS and handles all of the hard parts of displaying responsive images that follow best practices for performance on your website or application.
- Agility CMS Gatsby Source Plugin - our official Gatsby plugin that will only refresh content that has changed since your last build, so you can rest easy your builds will be fast, regardless of how many pages you have.
Preview Site (Gatsby Cloud): https://agility-gatsby-starter-5854363761.gtsb.io/
Production Site (Netlify): https://agility-gatsby-starter-gatsbycloud.netlify.com/
Learn how to get started with Gatsby and Agility CMS
- What is Agility CMS? What makes it different?
- Getting up and running
- How to build a production version of your project and test it
- Deploy
- Customizing your Agility Gatsby project further
- What is Agility CMS? What makes it different?
- Resources
- Roadmap
- Contributing
- Code of conduct
- License
npm install -g gatsby-cli
Additional information for getting started with Gatsby
Sign up for a free account using the Blog Template.
After signing up for a free account and logging into Agility CMS, click on the Get API Keys button on your dashboard.
Take note of your GUID and your Live API Key and Preview API Key. Copy these somewhere temporarily, or refer back to this screen when you begin to Configure your local environment.
git clone https://github.com/agility/agility-gatsby-starter
With NPM
cd agility-gatsby-starter
npm install
Rename ./.env.development.example to ./.env.development
cp .env.development.example .env.development
Add your development AGILITY_GUID and AGILITY_API_KEY variable values in .env.development
# Your Instance Id
AGILITY_GUID=
# Your Preview API Key (recommended) - you can get this from the Getting Started Page in Agility CMS. It starts with defaultpreview.
AGILITY_API_KEY=
# If using your Preview API Key, set this to true
AGILITY_API_ISPREVIEW=true
Rename ./.env.production.example to ./.env.production
cp .env.production.example .env.production
Add your production AGILITY_GUID and AGILITY_API_KEY variable values in .env.production
# Your Instance Id
AGILITY_GUID=
# Your Live API Key (recommended) - you can get this from the Getting Started Page in Agility CMS. It starts with defaultlive.
AGILITY_API_KEY=
# Since you won't want to preview here, set this to false
AGILITY_API_ISPREVIEW=false
Once the above steps are done, you can launch your local development server:
With NPM
npm start
It's good practice to build a production version and test it locally before publishing it or doing a pull request into master. Here's how to do it:
With NPM
npm run build
npm run serve
☝️ Deploy this starter repo in just minutes with Vercel. It will prompt you to enter your AGILITY_GUID, AGILITY_API_KEY, and AGILITY_API_ISPREVIEW.
☝️ Deploy this starter repo in just minutes with Netlify. You'll need to add your Agility CMS AGILITY_GUID, AGILITY_API_KEY, and AGILITY_API_ISPREVIEW variables in Netlify's Site settings > Build & deploy > Environment section.
You'll want to take a peek under the hood at some point and take the starter's configuration for Gatsby further. To get a better understanding of the options, please visit GatsbyJS Source Plugin for Agility CMS on GitHub for documentation.
Agility CMS is a headless Content Management System (CMS) that lets you define your custom content types, relationships and pages. This is called Content Architecture, and you can reuse this content for your websites and apps.
Agility believes that a successful website balances the User Experience (UX), Editor Experience (EX), and Developer Experience (DX).
While Gatsby tends to handle UX and DX quite well, too often editors are an after-thought in Gatsby (and other JAMstack) websites. They feel constrained by not being able to manage their sitemap and what content is on which pages.
Agility aims to empower and improve the Editor Experience by providing built-in Page Management. This means developers can build UI Components and leave editors to compose their pages.
Learn more about Agility CMS and Gatsby
See the open issues for a list of proposed features (and known issues).
See CODE OF CONDUCT for more information.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Thank you to all of you who have contributed to agility-gatsby-starter!
Distributed under the MIT License. See LICENSE for more information.