Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/buttercms/astro-starter-buttercms

Drop-in proof-of-concept Astro app, fully integrated with your ButterCMS account
https://github.com/buttercms/astro-starter-buttercms

astro butter buttercms headless headless-cms starter starter-kit starter-project vercel

Last synced: 6 days ago
JSON representation

Drop-in proof-of-concept Astro app, fully integrated with your ButterCMS account

Awesome Lists containing this project

README 

        
![recommended node version](https://img.shields.io/badge/node-v16-green)



# Astro + ButterCMS Starter Project



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](https://astro-starter-buttercms.vercel.app/), or you can click a button below to deploy your own copy of our starter

project to the provider of your choice.



[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/ButterCMS/astro-starter-buttercms&env=ASTRO_APP_BUTTER_CMS_API_KEY&envDescription=Your%20ButterCMS%20API%20Token&envLink=https://buttercms.com/settings/&project-name=astro-starter-buttercms&repo-name=astro-starter-buttercms&redirect-url=https://buttercms.com/onboarding/vercel-starter-deploy-callback/&production-deploy-hook=Deploy%20Triggered%20from%20ButterCMS&demo-title=ButterCMS%20Astro%20Starter&demo-description=Fully%20integrated%20with%20your%20ButterCMS%20account&demo-url=https://astro-starter-buttercms.vercel.app/&demo-image=https://cdn.buttercms.com/r0tGK8xFRti2iRKBJ0eY&repository-name=astro-starter-buttercms)



## 1. Installation



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



```bash

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.



```bash

$ echo 'ASTRO_APP_BUTTER_CMS_API_KEY=' >> .env

```



### 3. Run local server



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



```bash

$ npm run start

```



Congratulations! Your starter project is now live at [http://localhost:3000/](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.



[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/ButterCMS/astro-starter-buttercms&env=ASTRO_APP_BUTTER_CMS_API_KEY&envDescription=Your%20ButterCMS%20API%20Token&envLink=https://buttercms.com/settings/&project-name=astro-starter-buttercms&repo-name=astro-starter-buttercms&redirect-url=https://buttercms.com/onboarding/vercel-starter-deploy-callback/&production-deploy-hook=Deploy%20Triggered%20from%20ButterCMS&demo-title=ButterCMS%20Astro%20Starter&demo-description=Fully%20integrated%20with%20your%20ButterCMS%20account&demo-url=https://astro-starter-buttercms-demo.vercel.app/&demo-image=https://cdn.buttercms.com/r0tGK8xFRti2iRKBJ0eY&repository-name=astro-starter-buttercms)



### 5. Webhooks



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



### 6. Previewing Draft Changes



By default, your starter project is set up to allow previewing of draft changes saved in your ButterCMS.com account. To disable this functionality, set the following value in your .env file: ASTRO_APP_BUTTER_CMS_PREVIEW=false