Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

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

blog butter buttercms cms react vercel

Last synced: 6 days ago
JSON representation

Drop-in proof-of-concept app for React, fully integrated with your ButterCMS account.

Host: GitHub
URL: https://github.com/buttercms/react-starter-buttercms
Owner: ButterCMS
Created: 2022-02-04T15:03:06.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2023-11-10T14:40:09.000Z (about 1 year ago)
Last Synced: 2023-11-10T15:44:26.772Z (about 1 year ago)
Topics: blog, butter, buttercms, cms, react, vercel
Language: CSS
Homepage: https://react-starter-buttercms-demo.vercel.app
Size: 1.42 MB
Stars: 3
Watchers: 3
Forks: 11
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

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

# React + ButterCMS Starter Project

This React 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://react-starter-buttercms-demo.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%3A%2F%2Fgithub.com%2FButterCMS%2Freact-starter-buttercms&env=REACT_APP_BUTTER_CMS_API_KEY&envDescription=Your%20ButterCMS%20API%20Token&envLink=https%3A%2F%2Fbuttercms.com%2Fsettings%2F&project-name=react-starter-buttercms&repo-name=react-starter-buttercms&redirect-url=https%3A%2F%2Fbuttercms.com%2Fonboarding%2Fvercel-starter-deploy-callback%2F&production-deploy-hook=Deploy%20Triggered%20from%20ButterCMS&demo-title=ButterCMS%20React%20Starter&demo-description=Fully%20integrated%20with%20your%20ButterCMS%20account&demo-url=https%3A%2F%2Freact-starter-buttercms-demo.vercel.app%2F&demo-image=https://cdn.buttercms.com/r0tGK8xFRti2iRKBJ0eY&repository-name=react-starter-buttercms)

## 1. Installation

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

```bash
git clone https://github.com/ButterCMS/react-starter-buttercms.git
cd react-starter-buttercms
npm install
```

### 2. Set API Token

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

```bash
$ echo 'REACT_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 React 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

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