mirror of
https://github.com/kingomarnajjar/gatsby-starter-netlify-cms.git
synced 2026-07-26 06:37:25 +10:00
52 lines
2.5 KiB
Markdown
52 lines
2.5 KiB
Markdown
# Gatsby + Netlify CMS Starter
|
||
|
||
This repo contains an example business website that is built with [Gatsby](https://www.gatsbyjs.org/), and [Netlify CMS](https://www.netlifycms.org): **[Demo Link](https://gatsby-netlify-cms.netlify.com/)**.
|
||
|
||
It follows the [JAMstack architecture](https://jamstack.org) by using Git as a single source of truth, and [Netlify](https://www.netlify.com) for continuous deployment, and CDN distribution.
|
||
|
||
## Prerequisites
|
||
|
||
- Node (I recommend using v8.2.0 or higher)
|
||
- [Gatsby CLI](https://www.gatsbyjs.org/docs/)
|
||
|
||
## Getting Started (Recommended)
|
||
|
||
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. The example here is the Kaldi coffee company template (adapted from [One Click Hugo CMS](https://github.com/netlify-templates/one-click-hugo-cms)). Use the button below to build and deploy your own copy of the repository:
|
||
|
||
<a href="https://app.netlify.com/start/deploy?repository=https://github.com/AustinGreen/gatsby-starter-netlify-cms&stack=cms"><img src="https://www.netlify.com/img/deploy/button.svg" alt="Deploy to Netlify"></a>
|
||
|
||
After clicking that button, you’ll 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, you’ll need to set up Netlify’s Identity service to authorize users to log in to the CMS.
|
||
|
||
### Access Locally
|
||
```
|
||
$ git clone https://github.com/[GITHUB_USERNAME]/[REPO_NAME].git
|
||
$ cd [REPO_NAME]
|
||
$ yarn
|
||
$ npm run develop
|
||
```
|
||
To test the CMS locally, you'll need run a production build of the site:
|
||
```
|
||
$ npm run build
|
||
$ npm run serve
|
||
```
|
||
|
||
## Getting Started (Without Netlify)
|
||
```
|
||
$ gatsby new [SITE_DIRECTORY_NAME] https://github.com/AustinGreen/gatsby-starter-netlify-cms/
|
||
$ cd [SITE_DIRECTORY_NAME]
|
||
$ npm run build
|
||
$ npm run serve
|
||
```
|
||
|
||
### Setting up the CMS
|
||
Follow the [Netlify CMS Quick Start Guide](https://www.netlifycms.org/docs/quick-start/#authentication) 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](https://www.npmjs.com/package/node-gyp 'NPM node-gyp page')
|