Setting Up your Eleventy Development Enviornment

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 & 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.