gatsby-starter-netlify-cms/README.md
Austin Green f24765ebe6 rebase
2017-11-01 11:50:42 -04:00

2.1 KiB
Raw Blame History

Gatsby + Netlify CMS Starter

This repo contains an example blog that is built with Gatsby, and Netlify CMS: https://gatsby-netlify-cms.netlify.com/.

It follows the JAMstack architecture by using Git as a single source of truth, and Netlify for continuous deployment, and CDN distribution.

Getting Started

Prerequisites

  • Node (I recommend using v8.2.0 or higher)
  • Gatsby CLI

Run Locally

gatsby new [SITE_DIRECTORY_NAME] https://github.com/AustinGreen/gatsby-starter-netlify-cms/
$ cd [SITE_DIRECTORY_NAME]
$ gatsby build
$ gatsby serve

Accessing the CMS

Follow the Netlify CMS Quick Start Guide to set up authentication, and hosting.


Debugging

Windows users might encounter node-gyp errors when trying to npm install. To resolve, make sure that you have both Python 2.7 and the Visual C++ build environment installed.

npm config set python python2.7
npm install --global --production windows-build-tools

Full details here

Take a Test Drive

Netlify CMS can run in any frontend web environment, but the quickest way to try it out is by running it on a pre-configured starter site with Netlify. Our example here is the Kaldi coffee company template. Use the button below to build and deploy your own copy of the repository:

Deploy to Netlify

After clicking that button, youll authenticate with GitHub and choose a repository name. Netlify will then automatically create a repository in your GitHub account with a copy of the files from the template. Next, it will build and deploy the new site on Netlify, bringing you to the site dashboard when the build is complete. Next, youll need to set up Netlifys Identity service to authorize users to log in to the CMS.