search

ButterCMS / gridsome-starter-buttercms

Drop-in proof-of-concept project for Gridsome + ButterCMS, fully integrated with your ButterCMS account
https://gridsome-starter-buttercms.vercel.app
1 stars 1 forks source link
butter buttercms gridsome starter-kit starter-project tutorial vercel

readme

recommended node version

Gridsome + ButterCMS Starter Project

This Gridsome 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.

Deploy with Vercel

Important Note:

As of the time of this writing, it appears that development on the Gridsome framework has slowed. As such, this starter project will not be updated/maintained further unless a new version of Gridsome releases/it appears that development is continuing. This starter project can be considered deprecated until further notice.

1. Installation

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

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

2. Set API Token

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

$ echo 'GRIDSOME_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:8080/.

4. Deploy on Vercel

Deploy your Gridsome 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

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: GRIDSOME_APP_BUTTER_CMS_PREVIEW=false