Using the Eleventy Blog Starter

Eleventy paired with Agility CMS is a stack that delivers remarkable Developer Experience (DX), enables lightning-fast User Experiences (UX), and allows for best-in-class Editor Experience (EX). This tutorial is aimed to help you get started with Eleventy and Agility CMS using a starter site.

Develop Components, not Websites

When building a site with Eleventy and Agility, we always recommend developers start by taking a look at our agilitycms-eleventy-starter, rather than starting from a blank slate. It showcases features such as our native Page Management and shows how you should structure your Eleventy website. Our Eleventy and Agility starter serves as an example based on our recommended best-practices.

Editors have fine-grain control with the ability to manage all aspects of their page. They're able to control what pages are on their website, and what is on each page. This means you can focus on building UI Components (i.e. Page Modules and Page Templates) that editors will use/reuse to compose their pages.

Set Up the Instance

In order to get started with the Blog Starter, Sign Up for a Free Agility CMS account.

Once you've created an account, you will be able to create a new Instance based off of the Blog Starter with Eleventy.

Get your API Keys

Once logged into Agility CMS, you'll want to grab your API credentials so your Eleventy site can authenticate and retrieve data from your instance.

From your Agility CMS dashboard, click into Settings > API Keys.

Take note of your GUID and your Live API Key and Preview API Key credentials and copy these somewhere temporarily as you'll need to use them later.

Get the Code

Clone the starter repo from GitHub that has all the code you need to get started. Open up the code directory in your favorite Text Editor.

git clone git@github.com:agility/agilitycms-eleventy-starter.git

Run npm install or yarn install to install packages and dependencies

Set up Authentication

  1. Rename your .env.example file to .env
  2. Overwrite the values in the .env file using your GUID, Fetch and Preview API Keys.
# Your Instance Id
AGILITY_GUID=
# Your Live API Key
AGILITY_API_FETCH_KEY=
# Your Preview API Key
AGILITY_API_PREVIEW_KEY=

Start The Site

To run the site locally, run npm run start or yarn start. This will use the Preview Key in your .env file.

This will also load the latest (staging mode) content from Agility CMS. When you change the content in the CMS, simply reload your page to see those changes updated on the site.

If successful, your site's build should complete and you be able to view the site in your browser on http://localhost:8080.

Did you get a Build error?

If you get an error during the build, check your log and ensure that you've entered your GUID and API Keys in your .env file.

Next Steps

  Learn more about how this starter works.