Astro + ButterCMS Starter Project

Note: This is a customer version of the astro demo that will only work if locales is enabled on your account.

This Astro starter project fully integrates with dynamic sample content from your ButterCMS account, including main menu, pages, blog posts, categories, and tags, all with a beautiful, custom theme with already-implemented search functionality. All of the included sample content is automatically created in your account dashboard when you sign up for a free trial of ButterCMS.

View our live demo hosted at Vercel, or you can click a button below to deploy your own copy of our starter project to the provider of your choice.

1. Installation

First, clone the repo and install the dependencies by running npm install

git clone https://github.com/ButterCMS/astro-starter-buttercms.git
cd astro-starter-buttercms
npm install

2. Set API Token

To fetch your ButterCMS content, add your API token as an environment variable.

$ echo 'ASTRO_APP_BUTTER_CMS_API_KEY=<Your API Token>' >> .env

3. Run local server

To view the app in the browser, you'll need to run the local development server:

$ npm run start

Congratulations! Your starter project is now live at http://localhost:3000/.

4. Deploy on Vercel

Deploy your Astro app using Vercel, the creators of Next.js. With a single click, you'll create a copy of our starter project in your Git provider account, instantly deploy it, and institute a full content workflow connected to your ButterCMS account. Smooth.

5. Webhooks

The ButterCMS webhook settings are located at https://buttercms.com/webhooks/

6. Previewing Draft Changes

To preview draft changes, pass ?preview=1 as a query parameter in the URL. Note: previewing available on the main blog posts page, category page, tag page, landing pages, and for the collection items in the landing page navigation menu.