Product Analysis: Gatsby Contentful Photo Blog

Overview:

The Gatsby Contentful Photo Blog is a theme that allows users to set up their own personal photo blog using markdown, hashtags, and pagination. It requires a free Contentful account to get started and utilizes Gatsby and Contentful for development and production.

Features:

Environment Variables: Uses environment variables to securely store and pass connection credentials for Contentful.
Contentful Integration: Connects to Contentful and creates new content delivery tokens.
GraphQL Query: Runs GraphQL queries to fetch and render posts from Contentful.
Image Rendering: Utilizes Contentful's Image API and gatsby-plugin-image to render multiple variants of post images.
Pagination: Implements pagination for the listing pages, allowing for navigation between different pages of posts.
Post Detail Pages: Creates a separate detail page for each post, allowing users to view individual posts in more detail.
Markdown Rendering: Uses the gatsby-transformer-remark plugin to render post markdown as HTML, both in the detail page and teaser.
Detail Page Pagination: Adds previous and next buttons to the post detail page for easy navigation between posts.

Step 0 - Preparation:

Install dotenv: npm i dotenv
Add the following line to the top of your gatsby-config.js file:
```
require('dotenv').config()
```

Step 1 - Connect to Contentful:

Create new content delivery tokens via https://app.contentful.com/spaces/YOUR_SPACE_ID/api/keys
Install the source plugin: npm i gatsby-source-contentful
Duplicate the .env.example file and rename it to .env.development and .env.production
Adjust the .env files:
- Both should contain your Space ID
- env.development should use your Content Preview API access token
- Uncomment the line in env.development that sets the host to https://cpa.contentful.com
- env.production should use your Content Delivery API access token

Enable the gatsby-source-contentful plugin in your gatsby-config.js file:

plugins: [
  // ...
  {
    resolve: `gatsby-source-contentful`,
    options: {
      // ...
    },
  },
  // ...
]

Step 1b - Starting the server and executing the first GraphQL query:

Execute npm start to start the server.
Visit http://localhost:8000 to view the website.
Run the first GraphQL query to see all the posts added to Contentful.

Step 2 - Render posts on the home page:

Add a page query to src/pages/index.js and render the results.
Adjust the query to tell Gatsby to generate multiple variants of the post images.
Adjust the rendering in src/components/post-teaser.js.

Step 3 - Add pagination:

Move ./src/pages/index.html to ./src/templates/post-listing.html.
Move and rename index.module.css as well.
Install the plugin: npm i gatsby-awesome-pagination.
Create the listing pages in gatsby-node.js.
Adjust the query and rendering of the post listing.
Add sort, skip, and limit filters to the page query to ensure the desired page's posts are fetched.
Add pagination links to allow navigation back and forth.

Step 4 - Create a detail page for every post:

Create a new template for the post detail pages: ./src/templates/post.js.
Use the template to create the detail pages in gatsby-node.js.
Link the posts from the listing pages in ./src/templates/post-teaser.js.

Step 4b - Render markdown:

Install the Remark transformer plugin for markdown transformation: npm i gatsby-transformer-remark.
Add the plugin to the plugins in your gatsby-config.js file.
Render the post body markdown as HTML in ./src/templates/post.js.
Render the post body in the teaser as an excerpt in ./src/components/post-teaser.js and ./src/templates/post-listing.js.

Step 5 - Add detail page pagination:

Add paths to previous and next post to the post detail page context in gatsby-node.js.
Render previous and next buttons based on the post detail page's context.

Summary:

The Gatsby Contentful Photo Blog theme allows users to easily set up their own photo blog using Gatsby and Contentful. It provides features such as content delivery token integration, GraphQL queries for fetching and rendering posts, pagination for easy navigation between pages of posts, separate detail pages for each post, markdown rendering, and detail page pagination. It offers a comprehensive solution for creating and managing a personal photo blog.

Contentful Developer Relations

Community Code Of Conduct

Workshop Gatsby Photo Blog