https://github.com/jinksi/gatsbro

A starter project for creating lightning-fast websites with Gatsby and Netlify-CMS
https://github.com/jinksi/gatsbro

gatsby netlify-cms react

Last synced: 3 months ago
JSON representation

A starter project for creating lightning-fast websites with Gatsby and Netlify-CMS

• Host: GitHub
• URL: https://github.com/jinksi/gatsbro
• Owner: Jinksi
• License: mit
• Created: 2018-07-18T06:35:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-10T20:18:44.000Z (over 3 years ago)
• Last Synced: 2023-03-07T13:29:03.567Z (almost 2 years ago)
• Topics: gatsby, netlify-cms, react
• Language: JavaScript
• Homepage: https://gatsbro.netlify.com
• Size: 12.4 MB
• Stars: 21
• Watchers: 3
• Forks: 3
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gatsbro

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

[![dependencies](https://david-dm.org/jinksi/gatsbro.svg?style=flat-square)](https://david-dm.org/jinksi/gatsbro)

[![Netlify Status](https://api.netlify.com/api/v1/badges/67a7cc90-239b-43ff-806f-26adcaecb4cd/deploy-status)](https://app.netlify.com/sites/gatsbro/deploys)

An opinionated starter project for creating lightning-fast websites with [Gatsby](https://gatsbyjs.org) and [Netlify CMS](https://netlifycms.org).

- **[Gatsby](https://gatsbyjs.org)** static site generator

- **[Netlify CMS](https://github.com/netlify/netlify-cms)** for content management

## See also

[Netlify CMS Docs](https://www.netlifycms.org/docs/)  

[Netlify CMS Repo](https://github.com/netlify/netlify-cms)  

[Gatsby + Netlify CMS Starter](https://github.com/AustinGreen/gatsby-starter-netlify-cms)

## Get going

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/Jinksi/gatsbro&stack=cms)

1.  Hit the **Deploy to Netlify** button. This will:

- Clone the repo into your Github account

- Create you a new project on Netlify, build & deploy

1.  Once your Netlify project has been created, check a couple of settings:

- Enable **Identity**

- Change **Registration Preferences** to **Invite Only**

- Enable **Git Gateway**

1.  Invite users (probably yourself) to enable admin access

- Open the **Identity** tab and hit **Invite Users**

## Show me the CMS!

The CMS lives at [\_\_YOUR_SITE_NAME\_\_.netlify.com/admin](https://__YOUR_SITE_NAME__.netlify.com/admin).

## Developing

1.  Clone your repo to your local machine

1.  Install dependencies

`yarn` or `npm install`

1.  Run the development server

`yarn start` or `npm run start`

If you are adding or editing content locally in the CMS, a couple of things to note:

1.  Changes will be pushed to the remote repo.

1.  You will be prompted to enter your site's url, this is necessary for Netlify Identity to manage user login. This is stored in `localStorage`, so you might have to empty your browser cache if you are switching projects but remaining on `localhost:3000`.

## Editing CMS fields

The Netlify CMS configuration is located in `public/admin/config.yml`. This is where you will configure the pages, fields, posts and settings that are editable by the CMS.

Find out more in the [Netlify CMS Docs](https://www.netlifycms.org/docs/#configuration).

## See also

[Netlify CMS Docs](https://www.netlifycms.org/docs/)  

[Netlify CMS Repo](https://github.com/netlify/netlify-cms)  

[Hyperstatic](https://github.com/Jinksi/hyperstatic) – the same starter project minus Netlify CMS  

[Gatsby + Netlify CMS Starter](https://github.com/AustinGreen/gatsby-starter-netlify-cms)