Skip to content

huntercaron/boiled

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Boiled

A minimal & opinionated Gatsby boilerplate.

Basic setup of Gatsby with Styled-Components, and Netlify CMS.

To get your own version, click the button below.

Deploy to Netlify

Getting Started

Things you Need Installed

After installing, clone the repository using either the terminal or Github Desktop.

First Setup

After cloning the repo, open your terminal and cd to the directory and run yarn. This will install all the dependencies for the project.

Running Locally

Once that is done, get the site running and live-reloading by running gatsby develop.

You're good to go! Your site will be at http://localhost:8000/.

Setting up Netlify CMS

Netlify CMS is essentially a lightweight CMS text editor for your site.

It edits your static files and uses git to update them, meaning it has no speed impact on your actual site, it just gives you a slick backend.

It's all setup on the site, you just need to setup Github authentication for yourself.

Github authentication

First you’ll need to add your deployed site as an OAuth application in your GitHub settings. This guide shows you how (disregard the example code at the bottom).

Then in your code in 'static/admin/config.yml' you'll want to let the cms know where your github repo is.

Just change the repo field (on line 8) to your username and repo name.

  repo: your-username/your-repo-name

Then you're all set! Go to www.your-site-url.com/admin/ and Netlify CMS will be ready for you!

More info about the whole process here.

Docs & Guides

  • For other Gatsby commands look here.
  • I also strongly recommended the Gatsby tutorial here.
  • If using Netlify, simply commit to your site and it will rebuild.
  • If using Github pages, follow the guide here.
  • Wanna learn more about Netlify CMS with Gatsby? Here is a guide.

Extras

Recommended Tools

Versions

version 1.0.0

Setup and examples of normal pages, and dynamic pages generated from markdown files (in src/pages/content).

version 1.1.0

Now comes with Netlify CMS installed.

About

🥚 A minimal & opinionated Gatsby starter

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published