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.
npm install or
yarn install to install packages and dependencies
Set up Authentication
- Rename your
- Overwrite the values in the
.envfile 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 dev or
yarn dev. 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.