docs: improved contentful documentation (#1891)
This commit is contained in:
Shahed Nasser
@@ -1,328 +0,0 @@
|
||||
---
|
||||
title: Create a headless ecommerce store with Gatsby, Contentful & Medusa
|
||||
---
|
||||
|
||||
# Creating a headless ecommerce store with Gatsby, Contentful and Medusa
|
||||
|
||||
:::info About Medusa
|
||||
|
||||
Medusa is an open source headless commerce engine that allow you to create amazing digital commerce experiences. Medusa is highly customizable, allowing you to extend the core to fit your needs.
|
||||
|
||||
:::
|
||||
|
||||
## Introduction
|
||||
|
||||
In this guide we will go over how to set up a modern e-commerce store using [Gatsby](https://gatsby.com) as a front end, [Contentful](https://contentful.com) as a CMS system and Medusa as a store engine. The resulting e-commerce store will be blazingly fast, highly extendable and will provide the necessary foundation to grow and evolve your e-commerce stack as your business expands to new markets and develops new software requirements.
|
||||
|
||||
## Overview
|
||||
|
||||
After following the steps outlines in this series you will have:
|
||||
|
||||
- A Medusa store engine capable of managing products, processing orders, handling orders and integrating with all the tools in your e-commerce stack.
|
||||
- A statically generated Gatsby storefront that is on brand and customizable from homepage to checkout flow.
|
||||
- A headless CMS system that can be modified and extended to create the best customer experience.
|
||||
|
||||
You will make use of `medusa-plugin-contentful` which is a plugin to your Medusa store engine that syncronizes products and product variants between your Medusa engine and your Contentful space. This allows you to perform content enrichment in Contentful while keeping your core master data in Medusa, for a truly headless commerce setup.
|
||||
|
||||
Other concepts that will be covered in this series include:
|
||||
|
||||
- Gatsby plugins and [File System Route API](https://www.gatsbyjs.com/docs/reference/routing/file-system-route-api/)
|
||||
- [Contentful Migrations](https://www.contentful.com/developers/docs/tutorials/cli/scripting-migrations/)
|
||||
- Medusa payments, fulfillments and plugins
|
||||
|
||||
If you want to jump straight to the code for this series you can checkout:
|
||||
|
||||
- [`medusa-starter-contentful`](https://github.com/medusajs/medusa-starter-contentful)
|
||||
- [`medusa-contentful-storefront`](https://github.com/medusajs/medusa-contentful-storefront)
|
||||
|
||||
## Prerequisites
|
||||
|
||||
:::note
|
||||
|
||||
For a full guide to how to set up your development environment for Medusa please see [the tutorial](https://docs.medusajs.com/tutorials/set-up-your-development-environment)
|
||||
|
||||
:::
|
||||
|
||||
In order to get you started with your Gatsby, Contentful, Medusa store you must complete a couple of installations:
|
||||
|
||||
- Install the Medusa CLI
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @medusajs/medusa-cli -g
|
||||
```
|
||||
|
||||
- Install the Gatsby CLI
|
||||
|
||||
```bash npm2yarn
|
||||
npm install gatsby-cli -g
|
||||
```
|
||||
|
||||
- [Create a Contentful account](https://www.contentful.com/sign-up/)
|
||||
- [Install Redis](https://redis.io/topics/quickstart)
|
||||
|
||||
```
|
||||
brew install redis
|
||||
brew services start redis
|
||||
```
|
||||
|
||||
Medusa has support for SQLite and PostgreSQL and uses Redis for caching and queueing of asynchronous tasks. Redis is required for `medusa-plugin-contentful` to work correctly.
|
||||
|
||||
## Setting up your Medusa server
|
||||
|
||||
We will make use of `medusa new` to setup your local Medusa server.
|
||||
|
||||
```bash
|
||||
medusa new medusa-contentful-store https://github.com/medusajs/medusa-starter-contentful
|
||||
```
|
||||
|
||||
This command will setup a new directory at `medusa-contentful-store`, clone the `medusa-starter-contentful` into that directory and install the dependencies for the project.
|
||||
|
||||
### What's inside
|
||||
|
||||
You can now do `cd medusa-contentful-store` and open up your project in your text editor. Below is an overview of the directory structure and a walkthrough of what the different files do.
|
||||
|
||||
```
|
||||
medusa-contentful-store
|
||||
├── contentful-migrations
|
||||
| ├── hero.js
|
||||
| ├── index.js
|
||||
| ├── link.js
|
||||
| ├── navigation-item.js
|
||||
| ├── navigation-menu.js
|
||||
| ├── page.js
|
||||
| ├── product-variant.js
|
||||
| ├── product.js
|
||||
| ├── region.js
|
||||
| ├── tile-section.js
|
||||
| └── tile.js
|
||||
├── data
|
||||
| ├── contentful-seed.json
|
||||
| └── seed.json
|
||||
├── src
|
||||
| ├── api
|
||||
| ├── loaders
|
||||
| ├── services
|
||||
| └── subscribers
|
||||
├── .env
|
||||
├── medusa-config.js
|
||||
├── package.json
|
||||
└── README.md
|
||||
```
|
||||
|
||||
#### `package.json`
|
||||
|
||||
If you are familiar with Node you will probably notice that your Medusa store is simply a Node project. Looking inside the `package.json` file you will find that one of the packages that is installed in the project is the `@medusajs/medusa` package. This is the core Medusa package that comes prepacked with all the functionality necessary to do digital commerce - it is also this package that makes sure to register and use the plugins and custom functionality that are configured for your store.
|
||||
|
||||
#### `medusa-config.js`
|
||||
|
||||
Your plugins and store configuration is managed in the `medusa-config.js`, if you open up the file you will see that `medusa-plugin-contentful` is configured with options as shown below. Later we will be setting up your Contentful space so that we can add the necessary environment variables to your `.env` file.
|
||||
|
||||
```javascript
|
||||
// medusa-config.js
|
||||
|
||||
// Contentful Variables
|
||||
const CONTENTFUL_SPACE_ID = process.env.CONTENTFUL_SPACE_ID || "";
|
||||
const CONTENTFUL_ACCESS_TOKEN = process.env.CONTENTFUL_ACCESS_TOKEN || "";
|
||||
const CONTENTFUL_ENV = process.env.CONTENTFUL_ENV || "";
|
||||
|
||||
|
||||
const plugins = [
|
||||
...,
|
||||
{
|
||||
resolve: `medusa-plugin-contentful`,
|
||||
options: {
|
||||
space_id: CONTENTFUL_SPACE_ID,
|
||||
access_token: CONTENTFUL_ACCESS_TOKEN,
|
||||
environment: CONTENTFUL_ENV,
|
||||
},
|
||||
},
|
||||
...
|
||||
];
|
||||
|
||||
module.exports = {
|
||||
projectConfig: {
|
||||
redis_url: REDIS_URL,
|
||||
database_database: "./medusa-db.sql",
|
||||
database_type: "sqlite",
|
||||
store_cors: STORE_CORS,
|
||||
admin_cors: ADMIN_CORS,
|
||||
},
|
||||
plugins,
|
||||
};
|
||||
```
|
||||
|
||||
#### `/src`
|
||||
|
||||
In the `/src` directory there are 4 special subdirectories that are added for you already. These special directories can be used to add custom functionality to your store. Custom functionality can include custom endpoints (configured in `/api`), custom business logic (configured in `/services`), pub/sub-like subscriptions for asyncrhonous integration tasks (configured in `/subscribers`) and finally loader functions to be called when your Medusa server starts up (configured in `/loaders`). If you want to learn more about how to add custom functionality you can checkout [the tutorial](https://docs.medusajs.com/tutorials/adding-custom-functionality).
|
||||
|
||||
#### `/data`
|
||||
|
||||
We will be using two seed scripts to kickstart your development, namely:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run seed:contentful
|
||||
npm run seed
|
||||
```
|
||||
|
||||
Data for these seed scripts are contained in the `/data` directory.
|
||||
|
||||
When the seed scripts have been executed you will have a Contentful space that holds all the data for your website; this includes content for Pages, Navigtion Menu, etc.
|
||||
|
||||
#### `/contentful-migrations`
|
||||
|
||||
This directory contains scripts that create content types in your Contentful space. Contentful allows you to customize your content types with fields that can be used to hold all sorts of data, this makes it possible to create advanced data structures that will later be used to lay out your website. Writing migration scripts to evolve your content types is a really powerful tool as you can use it in CI/CD pipelines and makes your projects much more portable.
|
||||
|
||||
The migrations included in this project will create the following content types:
|
||||
|
||||
- **Page**: Represents a page on your website. Each page has a title and can take any number of "Content Modules". Content Modules can be either of the type Hero or Tile Section.
|
||||
- **Hero**: a component that can take a Title, CTA and a background image.
|
||||
- **Tile**: a component that can be added to a Tile Section and renders a Title, CTA and an Image.
|
||||
- **Tile Section**: a component that can hold a number of Tiles or Products. When used with a Product, the Tile Section will display the product thumbnail and it's title and will link to the product page.
|
||||
- **Link**: a component that can link to an external or internal path; or, alternatively, hold a reference to a Page or Product entry. If used with Page or Product, the link path will be inferred from the referenced entry.
|
||||
- **Navigation Item**: an item to include in a Navigation Menu. Each navigation item has a title that can be displayed in a menu and a link that defines where the user will be navigated to when the item is clicked.
|
||||
- **Product**: represents a product as syncronized from Medusa. A product's variants will be copied over as well.
|
||||
- **Product Variant**: The variants of a product.
|
||||
- **Region**: Represents an available region in Medusa.
|
||||
|
||||
## Creating a Contentful space
|
||||
|
||||
To create a new Contentful space log in to your Contentful account. If you already have a Contentful account with a Space configured you can click your organization name in the top left corner to reveal an overview of your organization's spaces. At the bottom of the spaces list you should click "Add space".
|
||||
|
||||
**Select "Community space" and "Web app only"**
|
||||
In this guide we will be using a free space which gives you an incredibly strong foundation for creating on-brand customer experiences and advances shopping flows.
|
||||
|
||||
|
||||
|
||||
**Add a name and select "Empty space"**
|
||||
|
||||
|
||||
|
||||
Once your space is set up you can go to your space home. We will now get the credentials needed for `medusa-plugin-contentful` to work.
|
||||
|
||||
Open your `.env` file in your text editor you should see:
|
||||
|
||||
```shell
|
||||
# .env
|
||||
JWT_SECRET=something
|
||||
COOKIE_SECRET=something
|
||||
|
||||
STRIPE_API_KEY=
|
||||
STRIPE_WEBHOOK_SECRET=
|
||||
|
||||
CONTENTFUL_SPACE_ID=
|
||||
CONTENTFUL_ACCESS_TOKEN=
|
||||
CONTENTFUL_ENV=
|
||||
```
|
||||
|
||||
Your `CONTENTFUL_SPACE_ID` can be found by going to your space home and checking your browser's URL bar. The space id is the alphanumeric string following `https://app.contentful.com/spaces/`. Copy this string and paste it into your `.env` file.
|
||||
|
||||
To get your `CONTENFUL_ACCESS_TOKEN` go to your space home and click **Settings** > **API keys**
|
||||
|
||||
|
||||
|
||||
Then click **Content management tokens** and click **Generate personal token**. After giving your token a name you can copy it to your `.env`
|
||||
|
||||
|
||||
|
||||
For `CONTENTFUL_ENVIRONMENT` add `master`.
|
||||
|
||||
You should now have a `.env` that looks like this:
|
||||
|
||||
```shell
|
||||
# .env
|
||||
JWT_SECRET=something
|
||||
COOKIE_SECRET=something
|
||||
|
||||
STRIPE_API_KEY=
|
||||
STRIPE_WEBHOOK_SECRET=
|
||||
|
||||
CONTENTFUL_SPACE_ID=****
|
||||
CONTENTFUL_ACCESS_TOKEN=CFPAT-*******
|
||||
CONTENTFUL_ENV=master
|
||||
```
|
||||
|
||||
## Migrating and Seeding your Contentful space
|
||||
|
||||
Now that we have collected your credentials we are ready to migrate the Contentful space to add the content types we talked about earlier. To migrate the Contentful space open up your command line and `cd` into `medusa-contentful-store`.
|
||||
|
||||
You can now run:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run migrate:contentful
|
||||
```
|
||||
|
||||
This script will run each of the migrations in the `contentful-migrations` directory. After it has completed navigate to your Contentful space and click "Content model" in the top navigation bar. You will see that the content types will be imported into your space. Feel free to familiarize yourself with the different types by clicking them and inspecting the different fields that they hold.
|
||||
|
||||
|
||||
|
||||
The next step is to seed the Contentful space with some data that can be used to display your ecommerce store's pages and navigation. To seed the database open up your command line and run:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run seed:contentful
|
||||
```
|
||||
|
||||
In your Contentful space navigate to "Content" and you will be able to see the different entries in your space. You can filter the entries by type to, for example, only view Pages:
|
||||
|
||||
|
||||
|
||||
You will notice that there are not any Products in your store yet and this is because we haven't created any products in your Medusa store.
|
||||
|
||||
To do this open your command line and run:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run seed
|
||||
npm run start
|
||||
```
|
||||
|
||||
This will seed your Medusa database, which will result in `medusa-plugin-contentful` synchronizing data to your Contentful space. Everytime you add or update a product the data will be copied into your Contentful space for further enrichment.
|
||||
|
||||
## Setting Featured Products
|
||||
|
||||
In Contentful navigate to "Content" and find the Page called "Home". We will now add some featured products to the home page.
|
||||
|
||||
- Click the "Home" entry and scroll down to the field called "Content modules"
|
||||
|
||||
|
||||
- Click the Content module named "Featured Products" and click "Add content" in the "Tiles" field
|
||||
|
||||
|
||||
- Click "Add existing content" as e will be adding the products that were copied over by Medusa
|
||||
|
||||
|
||||
- Select Medusa Waterbottle and Medusa Shirt and click "Insert 2 entries"
|
||||
|
||||
Make sure that everything is published by hitting publish in the sidebar on the right-hand side.
|
||||
|
||||
## Setting up your Gatsby storefront
|
||||
|
||||
Now that we have your Medusa server running and your Contentful space seeded with some starter data it is time to add a presentational layer that can be used by customers to browse and purchase the items in your store.
|
||||
|
||||
We have already created the storefront and you can install and use it by simply running:
|
||||
|
||||
```
|
||||
gatsby new medusa-contentful-storefront https://github.com/medusajs/medusa-contentful-storefront
|
||||
```
|
||||
|
||||
Once `gatsby new` is complete you should rename the `.env.template` file to `.env` and add a Content Delivery token. Your content delivery token is different from the personal access token you generated earlier, so make sure that you are using the correct token when you paste it into your `.env`.
|
||||
|
||||
To get your token go to **Settings** > **API Keys** > **Add API key**. Now click save and copy the token specified in the field "Content Delivery API - access token".
|
||||
|
||||
After you have copied the token and your space ID to your `.env`, you can start your Gatsby development server on port 8000 by running:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run start
|
||||
```
|
||||
|
||||
You can now go to https://localhost:8000 to check out your new Medusa store.
|
||||
|
||||
|
||||
|
||||
## Summary
|
||||
|
||||
Using three powerful tools we have now set up a modern headless ecommerce store on our local development machine. This setup can scale with your business's needs and evolve to fit create amazing commerce expereiences that are unique and on brand. The steps we took in this guide were really simple and fast: first we created a Medusa server using the Medusa CLI, we then configured a Contentful space by running migrations and seed scripts. We also installed a Gatsby front end for our Medusa store using the Gatsby CLI.
|
||||
|
||||
## What's next
|
||||
|
||||
In the next part we will dig deeper into how Contentful can be used to create pages, enrich your products and structure your content. We will also take a look at the files in your Gatsby storefront.
|
||||
|
||||
Stay tuned!
|
||||
@@ -1,316 +0,0 @@
|
||||
---
|
||||
title: Making your store more powerful with Contentful
|
||||
---
|
||||
|
||||
# Making your store more powerful with Contentful
|
||||
|
||||
In [part 1](https://docs.medusajs.com/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa/) of this series you have set up [Medusa](https://medusajs.com) with Contentful as your CMS system and added a Gatsby storefront. In this part you will get a further introduction to Contentful and learn how [`medusa-plugin-contentful`](https://github.com/medusajs/medusa/tree/master/packages/medusa-plugin-contentful) can be leveraged to make your store more powerful. Apart from a front page, product pages and a checkout flow, most ecommerce stores also need miscalleneous pages like About and Contact pages. In this guide you will add a Rich Text content module to your Contentful space so that you can make this pages cool. You will also see how the content modules can be used to give your product pages more life.
|
||||
|
||||
What you will do in this guide:
|
||||
|
||||
- Add a rich text content module
|
||||
- Add rich text to your `/about` page
|
||||
- Add a "Related Products" section to your product page
|
||||
|
||||
Topics covered:
|
||||
|
||||
- Contentful Migrations
|
||||
- Product enrichment
|
||||
|
||||
## Creating a rich text content module
|
||||
|
||||
In this guide you will make use of [Contentful Migrations](https://github.com/contentful/contentful-migration) to keep a versioned controlled record of how your Content evolves over time. The Contentful app allows you to create content models straight from their dashboard, however, when using the migrations tool you will be able to 1) quickly replicate your Contentful space and 2) incorporate migrations as part of a CI/CD pipeline. [You can read more about how to use CMS as Code here](https://www.contentful.com/help/cms-as-code/).
|
||||
|
||||
To prepare your migration create a new file at `contentful-migrations/rich-text.js` and add the following code:
|
||||
|
||||
```javascript
|
||||
// contentful-migrations/rich-text.js
|
||||
|
||||
module.exports = function (migration, context) {
|
||||
const richText = migration
|
||||
.createContentType("richText")
|
||||
.name("Rich Text")
|
||||
.displayField("title")
|
||||
|
||||
richText.createField("title").name("Title (Internal)").type("Symbol")
|
||||
richText.createField("body").name("Body").type("RichText")
|
||||
}
|
||||
```
|
||||
|
||||
This small snippet will create a content model in your Contentful space with two fields: a title which will be used to name entries in a meaningful manner (i.e. it won't be displayed to customers) and a body which contains the rich text to display. To apply your migration run:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run migrate:contentful --file contentful-migrations/rich-text.js
|
||||
```
|
||||
|
||||
If you go to your Contentful space and click Content Model you will see that the Rich Text model has been added to your space:
|
||||
|
||||
|
||||
The validation rules in the Page model only allow Hero and Tile Sections to be added to the Content Modules fields so you will need another migration to make it possible for pages to make use of the new Rich Text modules. Create a new migration at `contentful-migrations/update-page-module-validation.js` and add the following:
|
||||
|
||||
```javascript
|
||||
// contentful-migrations/update-page-module-validation.js
|
||||
|
||||
module.exports = function (migration, context) {
|
||||
const page = migration.editContentType("page")
|
||||
|
||||
page.editField("contentModules").items({
|
||||
type: "Link",
|
||||
linkType: "Entry",
|
||||
validations: [
|
||||
{
|
||||
linkContentType: ["hero", "tileSection", "richText"],
|
||||
},
|
||||
],
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
After migrating your space you are ready create your new contact page:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run migrate:contentful --file contentful-migrations/update-page-module-validation.js
|
||||
```
|
||||
|
||||
## Adding Rich Text to About
|
||||
|
||||
To use your new Rich Text module **Content > Page > About**, and click **Add Content > Page**. You will now make use of the new Rich Text module to add some more details about your store. You can write your own text or use the text provided below if you just want to copy/paste.
|
||||
|
||||
:::info About Medusa
|
||||
|
||||
Medusa is an open-source headless commerce engine for fast-growing businesses. Getting started with Medusa is very easy and you will be able to start selling online with a basic setup in no time, however, the real power of Medusa starts showing up when you add custom functionality and extend your core to fit your needs.
|
||||
|
||||
The core Medusa package and all the official Medusa plugins ship as individual NPM packages that you install into a Node project. You store and plugins are configured in your medusa-config.js file making it very easy to manage your store as your business grows. Custom functionality doesn't have to come from plugins, you can also add project-level functionality by simply adding files in your `src/` folder. Medusa will automatically register your custom functionalities in the bootstrap phase.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
|
||||
When you have added your text you can click **Publish changes** (make sure the About page is published too).
|
||||
|
||||
## Updating the storefront to support the Rich Text module
|
||||
|
||||
:::note
|
||||
|
||||
If you want to jump straight to the final frontend code visit [medusajs/medusa-contentful-storefront@part-2](https://github.com/medusajs/medusa-contentful-storefront/tree/part-2).
|
||||
|
||||
:::
|
||||
|
||||
To display your newly created Rich Text module open up the storefront code and create a new file at `src/components/rich-text/rich-text.jsx`.
|
||||
|
||||
```jsx
|
||||
// src/components/rich-text/rich-text.jsx
|
||||
|
||||
import React from "react"
|
||||
import { renderRichText } from "gatsby-source-contentful/rich-text"
|
||||
|
||||
import * as styles from "../../styles/rich-text.module.css"
|
||||
|
||||
const RichText = ({ data }) => {
|
||||
return (
|
||||
<div className={styles.container}>
|
||||
<div className={styles.content}>
|
||||
{data.body ? renderRichText(data.body) : ""}
|
||||
</div>
|
||||
</div>
|
||||
)
|
||||
}
|
||||
|
||||
export default RichText
|
||||
```
|
||||
|
||||
The `renderRichText` function is imported from the `gatsby-source-contentful` plugin to easily transform the text you entered in the Rich Text module to html. To make the Rich Text component render nicely add a style file as well at `src/styles/rich-text.module.css`.
|
||||
|
||||
```css
|
||||
/* src/styles/rich-text.module.css */
|
||||
|
||||
.container {
|
||||
display: flex;
|
||||
padding-top: 100px;
|
||||
padding-bottom: 100px;
|
||||
}
|
||||
|
||||
.content {
|
||||
margin: auto;
|
||||
max-width: 870px;
|
||||
}
|
||||
```
|
||||
|
||||
If you restart your storefront server now you will not be able to see your new Rich Text module just yet. The last step to making that happen will be to let the Page component know to render the new Rich Text component when it encounters Rich Text in the Page's Content Modules. In your editor open up the file `src/pages/{ContentfulPage.slug}.js` and add the following:
|
||||
|
||||
At the top of the file import your `RichText` component:
|
||||
|
||||
```javascript
|
||||
...
|
||||
import RichText from "../components/rich-text/rich-text"
|
||||
...
|
||||
```
|
||||
|
||||
Now in the `contentModules.map` function return the `RichText` component whenever a `ContentfulRichText` module is encountered. Add a case to the switch statement:
|
||||
|
||||
```javascript
|
||||
case "ContentfulRichText":
|
||||
return <RichText key={cm.id} data={cm} />
|
||||
```
|
||||
|
||||
Finally you will need to fetch the Rich Text data from Gatsby's data layer by modifying the GraphQL code at the bottom of the file after the line with `contentModules {` add:
|
||||
|
||||
```graphql
|
||||
... on ContentfulRichText {
|
||||
id
|
||||
body {
|
||||
raw
|
||||
}
|
||||
internal {
|
||||
type
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Restart your local Gatsby server and visit `http://localhost:8000/about`, you will now see the your newly added Rich Text module.
|
||||
|
||||
|
||||
|
||||
## Enriching your Product pages
|
||||
|
||||
You have now seen how the Page model in Contentful can be extended to include a new content module in a reusable and modular manner. The same idea can be extended to your Product pages allowing you to create completely bespoke universes around your products. You will use the same techniques as above to create a Related Products section below the "Medusa Shirt" product.
|
||||
|
||||
### Migrating Products
|
||||
|
||||
First, add a new field to the Product content model. Using migrations you can create a file `contentful-migrations/product-add-modules.js`:
|
||||
|
||||
```javascript
|
||||
// contentful-migrations/product-add-modules.js
|
||||
|
||||
module.exports = function (migration, context) {
|
||||
const product = migration.editContentType("product")
|
||||
|
||||
product
|
||||
.createField("contentModules")
|
||||
.name("Content Modules")
|
||||
.type("Array")
|
||||
.items({
|
||||
type: "Link",
|
||||
linkType: "Entry",
|
||||
validations: [
|
||||
{
|
||||
linkContentType: ["hero", "tileSection", "richText"],
|
||||
},
|
||||
],
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
Run the migration:
|
||||
|
||||
```bash npm2yarn
|
||||
npm run migrate:contentful --file contentful-migrations/product-add-modules.js
|
||||
```
|
||||
|
||||
### Adding "Related Products" Tile Section
|
||||
|
||||
After the migration you can now add Content Modules to Products, to enrich the Product pages with relevant content. In this guide you will add a Tile Section that holds "Related Products", but the functionality could be further extended to showcase look book images, inspirational content or more detailed product descriptions.
|
||||
|
||||
In Contentful go to **Content > Product > Medusa Shirt** scroll all the way to the bottom, where you should be able to find the new _Content Modules_ field:
|
||||
|
||||
|
||||
|
||||
Click **Add content > Tile Section** which will open a new Tile Section. For the Title write "Related Products", and for Tiles click **Add content > Add existing content > Medusa Waterbottle > Insert 1 entry**.
|
||||
|
||||
|
||||
|
||||
Click **Publish** and make sure that the Medusa Shirt product is published too.
|
||||
|
||||
Your data is now ready to be used in the storefront, but you still need to make a couple of changes to the storefront code to be able to view the new content.
|
||||
|
||||
## Adding Content Modules to Product pages
|
||||
|
||||
Just like you did for the Page component, you will have to fetch the Content Modules from Gatsby's GraphQL data layer.
|
||||
|
||||
In the file `src/pages/products/{ContentfulProduct.handle}.js` add the following in the GraphQL query at the bottom of the file (e.g. after the variants query):
|
||||
|
||||
```graphql
|
||||
# src/pages/products/{ContentfulProduct.handle}.js
|
||||
|
||||
contentModules {
|
||||
... on ContentfulTileSection {
|
||||
id
|
||||
title
|
||||
tiles {
|
||||
... on ContentfulProduct {
|
||||
id
|
||||
title
|
||||
handle
|
||||
thumbnail {
|
||||
gatsbyImageData
|
||||
}
|
||||
internal {
|
||||
type
|
||||
}
|
||||
}
|
||||
... on ContentfulTile {
|
||||
id
|
||||
title
|
||||
cta
|
||||
image {
|
||||
gatsbyImageData
|
||||
}
|
||||
link {
|
||||
linkTo
|
||||
reference {
|
||||
slug
|
||||
}
|
||||
}
|
||||
internal {
|
||||
type
|
||||
}
|
||||
}
|
||||
}
|
||||
internal {
|
||||
type
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This snippet will query the Content Modules defined for the product and will allow you to use the data in your components.
|
||||
|
||||
Next open up the `src/views/products.jsx` file and add the following snippets.
|
||||
|
||||
Import the `TileSection` component:
|
||||
|
||||
```javascript
|
||||
import TileSection from "../components/tile-section/tile-section"
|
||||
```
|
||||
|
||||
Add the Content Modules in the JSX just before the final closing `div`:
|
||||
|
||||
```jsx
|
||||
// src/views/products.jsx
|
||||
|
||||
<div className={styles.contentModules}>
|
||||
{product.contentModules?.map((cm) => {
|
||||
switch (cm.internal.type) {
|
||||
case "ContentfulTileSection":
|
||||
return <TileSection key={cm.id} data={cm} />
|
||||
default:
|
||||
return null
|
||||
}
|
||||
})}
|
||||
</div>
|
||||
```
|
||||
|
||||
Restart the Gatsby server and visit http://localhost:8000/product/medusa-shirt you should now see the new "Related Products" Tile Section below the Product page controls.
|
||||
|
||||
|
||||
|
||||
## Summary
|
||||
|
||||
In this guide you created a new content model for Rich Text input in Contentful using [contentful-migration](https://github.com/contentful/contentful-migration). You further extended the storefront to render the new Rich Text plugin. The concepts in this guide are meant to demonstrate how Contentful can be used to make your store more powerful in a modular and scalable way. The content modules covered in this guide could be further extended to add other custom modules, for example, you could add a Newsletter Signup, module that when encountered in the code renders a newsletter form.
|
||||
|
||||
## What's next
|
||||
|
||||
In the next part of this guide you will learn how to implement further commerce functionalities to your site such as adding support for discount codes, region based shopping and more. (Coming soon)
|
||||
|
||||
- [Deploying Medusa Server](../deployments/server/index.mdx)
|
||||
- [Deploying Medusa Admin](../deployments/admin/index.mdx)
|
||||
Reference in New Issue
Block a user