gatsby-starter-contentful

A Simplest starter template to build amazing static websites with Gatsby and Contentful. Inspired by gatsby-starter-gcn.

Features

• Contentful integration with starter
• SEO Friendly Component
  • OpenGraph sharing support
  • Sitemap Generation
• Google Analytics
• Progressive Web app
• Offline Support
• Gatsby Standard module for linting Javascript with StandardJS
• Stylelint support for Styled Components to lint the CSS in JS

Getting Started

Install

git clone https://github.com/MonadsTech/gatsby-starter-gcn.git
yarn install

Or via the Gatsby CLI

gatsby new gatsby-starter-contentful https://github.com/MonadsTech/gatsby-starter-gcn.git

Setup Contentful

1. Sign up for Contentful and create a new empty space

2. yarn run setup

3. Enter in the requested info for your Contentful space found here: app.contentful.com → Space Settings → API keys. You will need to provide both a standard API key (first tab) and a management key (second tab).

Customization

Website Data

Edit siteMeta data in /src/gatsby-config.js

  siteMetadata: {
    title: 'GCN', // Title of the website
    description: // Description of the website
      'A starter template to build amazing static websites with Gatsby, Contentful and Netlify',
    siteUrl: 'https://gcn.netlify.com', // Website URL. Do not include trailing slash
    image: '/images/share.jpg', // Path to default image for SEO
    menuLinks: [ // The links used in the top menu
      {
        name: 'Home',
        slug: '/',
      },
      {
        name: 'About',
        slug: '/about/',
      },
      {
        name: 'Contact',
        slug: '/contact/',
      },
    ],
    /*
      Root URL for site 
    */
    basePath: '/', // Defaults to the homepage
  }

Note: If you do not see your changes reflected when developing locally you may need to run yarn clean followed by restarting the server via yarn develop.

Using Gatsby Standard

1. Quickly check your code for errors with the yarn test script
2. You can view the Gatsby Standard README for details on how to integrate this project's included Gatsby Standard, Stylelint, and Prettier modules into your text editor

Content and SEO

1. You can replace the share.jpg and favicon.png files in the static/images directory.
2. Meta descriptions are defined in Contentful. If you choose to leave this field blank on new posts a 320 character excerpt of the post/page will be used instead.

Deployment

Manual Netlify Deployment

1. Run gatsby build

2. Drag and drop the folder /public/ into Netlify

Netlify Deployment From Git (Recommended)

1. New Netlify website from Git

2. Connect with GitHub and select your repo

3. Navigate to Netlify: Settings → Build & Deploy → Build Environment Variables. Add the following environment variables using the Space ID and Content Delivery API - access token from Contentful. Additionally if desired you can enter a Google Analytics ID. The variables must be named exactly like this in order to work properly.

ACCESS_TOKEN
SPACE_ID
GOOGLE_ANALYTICS

4. Navigate to Netlify: Deploys. Click Trigger deploy to manually trigger a deploy to confirm the website is building successfully using your build environment variables. At this point be aware that every time you push to master a deploy will automatically start and be published to production.

Additional Settings

Contentful Webhook (Optional)

1. Navigate to Netlify: Settings → Build & Deploy → Build hooks. Create a new build hook.

2. Navigate to Contentful: app.contentful.com → Space Settings → Webhooks. Create a webhook using the Netlify build URL that you just created and configure which events should trigger the build on production. For example the following will rebuild the production website every time a post or page is published, unpublished or deleted:

Useful Tips

• If you make edits to your Contentful space while running yarn develop you will need to stop it and rerun the command to see the changes reflected. For example a new post or page will not automatically show up until the website has been rebuilt.
• DO NOT store your Contentful access tokens or space ids anywhere in GitHub. Treat them like passwords.