Working with React and having an emphasis on speedy performance, GatsbyJS is a promising static site generator that allows you to connect your web projects to a variety of APIs and data sources; including Contentful’s content infrastructure.
How to build your first GatsbyJS website with Contentful
This piece will walk you through getting your GatsbyJS website up and running with Contentful. Contentful makes it easy for you to focus on developing beautiful, well-performing websites while we deliver the content - this makes us a great companion to the full-fledged static content authoring experience offered by GatsbyJS.
Here’s an overview of what’s involved:
- Create a free Contentful account
- Clone a sample repo
- Create a space on Contentful to store content
- Generate your Content Management and Content Delivery API access tokens
- Import data into your space
- Tweak your configuration file
- Preview a production build
- Publish and go live
This guide assumes that you have GatsbyJS installed and, optionally, a Github account.
Create your free Contentful account
You will also need a free Contentful account - creating one only takes a moment and we promise not to spam you.
Start by using this with the Gatsby CLI:
gatsby new contentful-starter https://github.com/contentful-userland/gatsby-contentful-starter
Alternatively, you can also clone a sample repo from Github:
git clone firstname.lastname@example.org:contentful-userland/gatsby-contentful-starter.git
And go into the directory and install the required dependencies with:
Create a new space to store content
A Space within Contentful serves as a storage area for content that will be used in your website and can be configured to serve specific purposes. Content is described and stored using a data model which we call content types; these are entirely configurable.
Create a new empty space by opening the sidebar menu and adding a Space. Give the space an apt name and click "Create" to go ahead with making it.
Generate access tokens
Before getting to the exciting part of setting up your website, you first need to generate three access tokens to get your Contentful-powered website up and running by fetching data from the API.
Head over to your Space Settings dropdown menu and navigate to the APIs section. From there, navigate to the tab for the API token you would like to generate.
The Content Management API is used for write access to your space, so keep the generated token safe and private. Hit "Generate Personal Token", give it a name and click “Generate”. Copy the token value and keep it safe and private - this is the only time you’ll be able to view it in your dashboard.
The Content Delivery API provides read-only access to your data and is one of the ways we deliver content to your website. Content is served via our Content Delivery Network (CDN). Click "Add API key" in the Content Delivery/Preview tab area. Grab the Space ID and personal Content Delivery API access token - you’ll need this in a bit.
The Content Preview API works much like the Content Delivery API, except it shows content internally for you to preview and hence does not use the CDN to serve content; since viewing is only limited to you, the previewing user. Creating an API key is the same here as you did with Content Delivery.
Content model and configuration
Start setting things up with the
npm run setup command, which first prompts you for the ID of the empty Space you just created along with the API access tokens for Content Management, Content Delivery, and Content Preview.
After that, it writes the credentials you provided into a file named .contentful.json into lines of code that look like so:
Using the credentials in the .contentful.json file, content can now be imported into your space to being displayed on your website via our API.
It’s ready, let’s publish
Time to check out your new website - preview changes in a local environment by running your website using the
npm run dev command. This uses the Contentful Preview API to show unpublished content as if they were already published - perfect for a development or staging environment.
If you like what you see, use the
npm run build command to start a static production build of your near-ready website and put it on a static host of your choice. After that, the
npm run deploy command allows you to publish what you have on the production build onto GitHub pages.
Your static files can then be deployed on a variety of platforms of your choice, like BitBalloon and GitHub Pages. Take your pick. Contentful gives you infrastructure for the content in your stack, that matches your modular and agile way of working with platform independence and by serving as a layer in your stack.
Our CDN is key to all of this; it ensures your website and its users can access your content quickly and reliably. Content is just an API call away, as demonstrated by the use of APIs to grab your content above.
That’s a quick overview of how to get your website up and running from scratch using Contentful and GatsbyJS - and we've just scratched the surface of what Contentful can do for you and your web projects.
Our cloud-based solution for content infrastructure is designed to scale to grow, so your content is always available regardless of load peaks and increases in userbase. Check out our Developer Center to learn more on how our tech works and what it can do for your web projects, or head over to the Guides and tutorials section to see ways you and your web projects can work with Contentful.