Medusa is an open source ecommerce platform that provides developers with customizability and extendability within all of its 3 components - the headless server, the admin, and the storefront.
Whether you want to add third-party integrations or custom functionalities, you have full freedom with how you implement them. Medusa is an open source ecommerce platform that comes packed with important ecommerce features out-of-the-box and ready-made plugins that you can install with a plug-and-play style.
In this tutorial, you’ll learn how to add product reviews to your Medusa server for your online store. You’ll also customize both the Medusa admin and Next.js storefront of your online store to show the reviews, and allow customers to add their reviews to products on the storefront of your online store.
You can find the code for this ecommerce tutorial in this GitHub repository.
Ecommerce Platform Prerequisites
Before you follow along with this tutorial, you must have the following requirements installed:
- Node.js v14 or greater
- PostgreSQL
Ecommerce Server Setup
To install the Medusa server, you need to install the CLI tool first:
1npm install -g @medusajs/medusa-cli
Then, run the following command to install the Medusa server:
1medusa new medusa-reviews
This installs your Medusa server into a newly-created directory
.Copy to clipboardmedusa-reviews
Configure PostgreSQL Database
Create an empty PostgreSQL database. Then, in
in the root of your Medusa server directory, add the following environment variable:Copy to clipboard.env
1DATABASE_URL=<YOUR_DATABASE_URL>
Where
is the URL to the database schema you just created in PostgreSQL. The URL should be of the formatCopy to clipboard<YOUR_DATABASE_URL>
. For example,Copy to clipboardpostgres://<USERNAME>:<PASSWORD>@<HOST>/<DB_NAME>
.Copy to clipboardpostgres://postgres:postgres@localhost/medusa-reviews
Then, change the database configuration in the exported object in
to use PostgreSQL instead of SQLite:Copy to clipboardmedusa-config.js
1234567891011module.exports = {projectConfig: {//...database_url: DATABASE_URL,database_type: "postgres",//comment out or remove the following lines:// database_database: "./medusa-db.sql",// database_type: "sqlite",},plugins,};
Seed and Migrate the Database
Finally, run the following command to migrate Medusa’s database schema and seed it with demo data:
1npm run seed
Add Product Reviews
In this section, you’ll add the
model, its associated repository, the migration to create it in the database, and the service to facilitate accessing and manipulating product reviews in the database from endpoints.Copy to clipboardProductReview
Create the ProductReview model
Before you create the model, install the
library to add validation to some of the columns in the new model:Copy to clipboardclass-validator
1npm install class-validator
Then, create the file
with the following content:Copy to clipboardsrc/models/product-review.ts
123456789101112131415161718192021222324252627282930313233343536import { BaseEntity, Product } from "@medusajs/medusa"import { BeforeInsert, Column, Entity, Index, JoinColumn, ManyToOne } from "typeorm"import { Max, Min } from "class-validator"import { generateEntityId } from "@medusajs/medusa/dist/utils"@Entity()export class ProductReview extends BaseEntity {@Index()@Column({ type: "varchar", nullable: true })product_id: string@ManyToOne(() => Product)@JoinColumn({ name: "product_id" })product: Product@Column({ type: "varchar", nullable: false })title: string@Column({ type: "varchar", nullable: false })user_name: string@Column({ type: "int" })@Min(1)@Max(5)rating: number@Column({ nullable: false })content: string@BeforeInsert()private beforeInsert(): void {this.id = generateEntityId(this.id, "prev")}}
You create a new model
that extendsCopy to clipboardProductReview
.Copy to clipboardBaseEntity
adds 3 common columnsCopy to clipboardBaseEntity
,Copy to clipboardid
andCopy to clipboardcreated_at
.Copy to clipboardupdated_at
You additionally add the columns
,Copy to clipboardid
,Copy to clipboardproduct_id
,Copy to clipboardtitle
,Copy to clipboarduser_name
, andCopy to clipboardrating
.Copy to clipboardcontent
You also add a method to be run before inserting a new record in the database for this model which uses a utility function from Medusa. If the record doesn’t have an ID, a random and unique ID is generated for it.
Create the Repository
The next step is to create the Typeorm repository for this model. Typeorm repositories provide you an API to perform a variety of actions on tables in the database
Create the file
with the following content:Copy to clipboardsrc/repositories/product-review.ts
123456import { EntityRepository, Repository } from "typeorm"import { ProductReview } from "../models/product-review"@EntityRepository(ProductReview)export class ProductReviewRepository extends Repository<ProductReview> { }
Create the Migration
Migrations are used to add or modify a database schema before running the server. It eliminates the need to do it manually on your RDBS each time you want to install your server.
Typeorm migration filenames are prefixed with a timestamp, so you have to create your own using this command:
1npx typeorm migration:create -n ProductReview --dir src/migrations
This will create the migration
in the directoryCopy to clipboardProductReview
. You should find a file insideCopy to clipboardsrc/migrations
that has a file name of the formatCopy to clipboardsrc/migrations
.Copy to clipboard<TIMESTAMP>-ProductReview.ts
Inside the migration, there’s an
method and aCopy to clipboardup
method. TheCopy to clipboarddown
method is executed when you run the migration, and theCopy to clipboardup
method is executed when you revert the migration.Copy to clipboarddown
Replace the
method with the following:Copy to clipboardup
12345678910111213141516public async up(queryRunner: QueryRunner): Promise<void> {await queryRunner.query(`CREATE TABLE IF NOT EXISTS "product_review" ("id" character varying NOT NULL, "product_id" character varying NOT NULL,"title" character varying NOT NULL, "user_name" character varying NOT NULL,"rating" integer NOT NULL, "content" character varying NOT NULL,"created_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now(), "updated_at" TIMESTAMP WITH TIME ZONE NOT NULL DEFAULT now())`)await queryRunner.createPrimaryKey("product_review", ["id"])await queryRunner.createForeignKey("product_review", new TableForeignKey({columnNames: ["product_id"],referencedColumnNames: ["id"],referencedTableName: "product",onDelete: "CASCADE",onUpdate: "CASCADE"}))}
This creates the table with its columns, makes the column
the primary key, and adds a foreign key on the columnCopy to clipboardid
.Copy to clipboardproduct_id
Then, replace the
method with the following:Copy to clipboarddown
123public async down(queryRunner: QueryRunner): Promise<void> {await queryRunner.dropTable("product_review", true)}
This drops the table
if you revert the migration.Copy to clipboardproduct_review
Before you can run migrations with Medusa, you need to run the
command to transpile the Typescript files into JavaScript files:Copy to clipboardbuild
1npm run build
Then, run the following command to run the migrations:
1medusa migrations run
This runs the migration you created which creates a new table
in the database for your Medusa server.Copy to clipboardproduct_review
Create the Service
In this section, you’ll create the service that you’ll use in endpoints to access or add product reviews.
Create the file
with the following content:Copy to clipboardsrc/services/product-review.js
12345678910111213141516171819202122232425262728293031323334353637import { BaseService } from "medusa-interfaces";class ProductReviewService extends BaseService {constructor({ productReviewRepository, manager }) {super();this.productReviewRepository = productReviewRepositorythis.manager = manager}async getProductReviews (product_id) {const productReviewRepository = this.manager.getCustomRepository(this.productReviewRepository);return await productReviewRepository.find({product_id});}async addProductReview (product_id, data) {if (!data.title || !data.user_name || !data.content || !data.rating) {throw new Error("product review requires title, user_name, content, and rating")}const productReviewRepository = this.manager.getCustomRepository(this.productReviewRepository);const createdReview = productReviewRepository.create({product_id: product_id,title: data.title,user_name: data.user_name,content: data.content,rating: data.rating})const productReview = await productReviewRepository.save(createdReview);return productReview}}export default ProductReviewService;
This creates the service
. This service has 2 methods.Copy to clipboardProductReviewService
gets all reviews for a product ID, andCopy to clipboardgetProductReviews
creates a new product review for a product ID using data passed to it as a second parameter.Copy to clipboardaddProductReview
Create Endpoints
Finally, you’ll create 3 new endpoints on your Medusa server:
- A
routeCopy to clipboardGET
to get reviews for a product on the storefront.Copy to clipboard/store/products/:id/reviews
- A
routeCopy to clipboardPOST
to add a new review for a product on the storefront.Copy to clipboard/store/products/:id/reviews
- A
routeCopy to clipboardGET
to get reviews on the Medusa admin.Copy to clipboard/admin/products/:id/reviews
Create the file
with the following content:Copy to clipboardsrc/api/index.js
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748import { Router } from "express"import bodyParser from "body-parser"import cors from "cors"import { projectConfig } from "../../medusa-config"export default () => {const router = Router()const storeCorsOptions = {origin: projectConfig.store_cors.split(","),credentials: true,}router.get("/store/products/:id/reviews", cors(storeCorsOptions), (req, res) => {const productReviewService = req.scope.resolve("productReviewService")productReviewService.getProductReviews(req.params.id).then((product_reviews) => {return res.json({product_reviews})})})router.use(bodyParser.json())router.options("/store/products/:id/reviews", cors(storeCorsOptions))router.post("/store/products/:id/reviews", cors(storeCorsOptions), (req, res) => {const productReviewService = req.scope.resolve("productReviewService")productReviewService.addProductReview(req.params.id, req.body.data).then((product_review) => {return res.json({product_review})})})const corsOptions = {origin: projectConfig.admin_cors.split(","),credentials: true,}router.options("/admin/products/:id/reviews", cors(corsOptions))router.get("/admin/products/:id/reviews", cors(corsOptions), async (req, res) => {const productReviewService = req.scope.resolve("productReviewService")productReviewService.getProductReviews(req.params.id).then((product_reviews) => {return res.json({product_reviews})})})return router;}
Notice that you have to use the
middleware with the configuration imported fromCopy to clipboardcors
for each route. If you don’t use theCopy to clipboardmedusa-config.js
middleware for the routes then you will not be able to access them from the storefront or from the admin.Copy to clipboardcors
In the
routeCopy to clipboardGET
, you retrieve theCopy to clipboard/store/products/:id/reviews
that is registered in the scope by the Medusa server when you run it. You then use the service to retrieve the reviews using the methodCopy to clipboardproductReviewService
.Copy to clipboardgetProductReviews
The
routeCopy to clipboardGET
is similar to theCopy to clipboard/admin/products/:id/reviews
routeCopy to clipboardGET
, but it uses the cors options for admin requests.Copy to clipboard/store/products/:id/reviews
In the
routeCopy to clipboardPOST
, you retrieve theCopy to clipboard/store/products/:id/reviews
and use theCopy to clipboardproductReviewService
method to add a review for the product, then return the created product review.Copy to clipboardaddProductReview
Run the Server
To run the server, run the following command:
1npm start
This runs the server on
. Make sure the server is running throughout the tutorial.Copy to clipboardlocalhost:9000
You can test out the endpoints you just added through a tool like Postman, but you’ll be testing them out throughout the rest of the tutorial.
Open Source Ecommerce Platform Admin Setup Admin Setup
The next step is to install and set up the Medusa Admin for your online store.
In your terminal and in a different directory than the Medusa server, run the following command to install the Medusa admin for your online store:
1git clone https://github.com/medusajs/admin medusa-reviews-admin
Then, change to the newly-created directory
and install the necessary dependencies:Copy to clipboardmedusa-reviews-admin
12cd medusa-reviews-adminnpm install
Create Reviews Component
You’ll show the reviews on the details page of each product.
So, create the file
with the following content:Copy to clipboardsrc/domain/products/product-form/sections/reviews.js
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950import { Box, Flex, Text } from "rebass"import React, { useEffect, useState } from "react"import BodyCard from "../../../../components/organisms/body-card"import { ReactComponent as Star } from "../../../../assets/svg-2.0/star.svg"import medusaRequest from "../../../../services/request"const Reviews = ({ id }) => {const [reviews, setReviews] = useState([])useEffect(() => {medusaRequest("get", `/admin/products/${id}/reviews`).then((response) => setReviews(response.data.product_reviews)).catch((e) => console.error(e))}, [])return (<BodyCard title="Product Reviews">{reviews.length === 0 && (<span>There are no reviews for this product</span>)}{reviews.length > 0 &&reviews.map((review) => (<Box key={review.id} bg="light" padding="2" mb="2"><Flex justifyContent="space-between"><Box mr={4}><Text fontWeight="700" mb={3}>{review.title}</Text></Box><Flex mr={4}>{Array(review.rating).fill(0).map(() => (<Star fill="yellow" />))}</Flex></Flex><Text color="gray">By {review.user_name}</Text><br /><Text>{review.content}</Text><br /><Text color="gray">{review.created_at}</Text></Box>))}</BodyCard>)}export default Reviews
In this code snippet, you retrieve the reviews from the ecommerce server using the endpoint you created earlier, then you display the reviews if there are any.
Then, in
import theCopy to clipboardsrc/domain/products/product-form/index.tsx
component at the top of the file:Copy to clipboardReviews
1import Reviews from "./sections/reviews"
And in the returned JSX in the component, add the following before the
wrappingCopy to clipboarddiv
:Copy to clipboardRawJSON
12345678//add this<div className="mt-large"><Reviews id={product.id} /></div>//before this<div className="mt-large"><RawJSON data={product} title="Raw product" /></div>
Test it Out
If you run your medusa admin with the following command:
1npm run develop
You’ll first be asked to log in to the admin. You can use the demo email “admin@medusa-test.com” and password “supersecret”.
After you log in, go to the Products page from the sidebar, then choose one of the existing products on your ecommerce site.
Scroll down and you should find “Product Reviews” but there are currently no reviews to view on your ecommerce website.
You’ll come back to this page after adding the “Add Review” functionality on the storefront of your ecommerce website.
Setup Next.js Storefront for your Online Store
This section covers how to show product reviews on the Next.js storefront and allow users to add their reviews on your ecommerce website.
If you’re alternatively using the Gatsby storefront or your custom storefront for your ecommerce website, you can still follow along to see the general approach of how to implement it in the storefront of your ecommerce website.
In your terminal and in a different directory than the directories holding the Medusa server and Medusa admin, run the following command to install the Next.js storefront:
1npx create-next-app -e https://github.com/medusajs/nextjs-starter-medusa medusa-reviews-storefront
Then, change to the newly created directory
and rename theCopy to clipboardmedusa-reviews-storefront
file:Copy to clipboard.env
12cd medusa-reviews-storefrontmv .env.template .env.local
You need to install a few libraries that are useful for this tutorial:
1npm install --save @heroicons/react react-hyper-modal yup
Where
is used to show a star icon for the rating,Copy to clipboard@heroicons/react
is used to easily create a modal for the product review form, andCopy to clipboardreact-hyper-modal
is used for the form validation.Copy to clipboardyup
Implement Product Reviews
In this section, you’ll show the product reviews under the description on every product page. You’ll also show a button to add a new review. This button opens a modal with a form to add the review.
In
add the following imports at the beginning of the file:Copy to clipboardpages/product/[id].js
12345import * as Yup from 'yup';import { useFormik } from "formik";import HyperModal from 'react-hyper-modal';import { StarIcon } from "@heroicons/react/solid";import axios from "axios";
Then, at the beginning of the
component, add the following state variables:Copy to clipboardProduct
12const [reviews, setReviews] = useState([]);const [isModalOpen, setModalOpen] = useState(false);
The
state variable is used to store the reviews retrieved from the server. TheCopy to clipboardreviews
state variable is used to control whether the modal holding the product review form is opened or closed.Copy to clipboardisModalOpen
Also, add a variable that uses Formik and Yup to easily create a form with validation functionalities:
12345678910111213141516171819202122232425262728const reviewFormik = useFormik({initialValues: {title: "",user_name: "",rating: 1,content: ""},validationSchema: Yup.object().shape({title: Yup.string().required(),user_name: Yup.string().required(),rating: Yup.number().min(1).max(5),content: Yup.string().required()}),onSubmit: (values) => {axios.post(`${BACKEND_URL}/store/products/${product.id}/reviews`, {data: {title: values.title,user_name: values.user_name,rating: values.rating,content: values.content}}).then(() => {getReviews()setModalOpen(false)})}})
This form has 4 fields:
,Copy to clipboardtitle
,Copy to clipboarduser_name
, andCopy to clipboardrating
. All fields are required, and the value of theCopy to clipboardcontent
field must be at least 1 and at most 5Copy to clipboardrating
On submit, a
request is sent to the endpoint you created earlier, and you pass the review data in the body. Then, the reviews are retrieved from the server using theCopy to clipboardPOST
function and the modal is closed.Copy to clipboardgetReviews
Next, add the
function and aCopy to clipboardgetReviews
that gets the reviews whenever theCopy to clipboarduseEffect
changes:Copy to clipboardproduct
1234567891011useEffect(() => {if (product) {getReviews()}// eslint-disable-next-line react-hooks/exhaustive-deps}, [product])function getReviews () {axios.get(`${BACKEND_URL}/store/products/${product.id}/reviews`).then((response) => setReviews(response.data.product_reviews))}
This retrieves the reviews from the server using the endpoint you created earlier on the server.
Finally, add the following before the last 3 closing
elements in the returned JSX:Copy to clipboarddiv
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061//add this<div style={{marginTop: "30px"}}><p>Product Reviews</p><HyperModalisOpen={isModalOpen}requestClose={() => setModalOpen(false)}renderOpenButton={() => {return (<button className={styles.addbtn} onClick={() => setModalOpen(true)}>Add Review</button>);}}><form onSubmit={reviewFormik.handleSubmit} style={{padding: "20px"}}><h2>Add Review</h2><div style={{marginBottom: "10px"}}><label htmlFor="title">Title</label><input type="text" name="title" id="title" onChange={reviewFormik.handleChange}value={reviewFormik.values.title} style={{display: "block", width: "100%"}} />{reviewFormik.touched.title && reviewFormik.errors.title && <span style={{color: "red"}}>{reviewFormik.errors.title}</span>}</div><div style={{marginBottom: "10px"}}><label htmlFor="user_name">User Name</label><input type="text" name="user_name" id="user_name" onChange={reviewFormik.handleChange}value={reviewFormik.values.user_name} style={{display: "block", width: "100%"}} />{reviewFormik.touched.user_name && reviewFormik.errors.user_name && <span style={{color: "red"}}>{reviewFormik.errors.user_name}</span>}</div><div style={{marginBottom: "10px"}}><label htmlFor="rating">Rating</label><input type="number" name="rating" id="rating" onChange={reviewFormik.handleChange}value={reviewFormik.values.rating} min="1" max="5" style={{display: "block", width: "100%"}} />{reviewFormik.touched.rating && reviewFormik.errors.rating && <span style={{color: "red"}}>{reviewFormik.errors.rating}</span>}</div><div style={{marginBottom: "10px"}}><label htmlFor="content">Content</label><textarea name="content" id="content" onChange={reviewFormik.handleChange}value={reviewFormik.values.content} style={{display: "block", width: "100%"}} rows={5}></textarea>{reviewFormik.touched.content && reviewFormik.errors.content && <span style={{color: "red"}}>{reviewFormik.errors.content}</span>}</div><button className={styles.addbtn}>Add</button></form></HyperModal>{reviews.length === 0 && <div style={{marginTop: "10px"}}>There are no product reviews</div>}{reviews.length > 0 && reviews.map((review, index) => (<div key={review.id} style={{marginTop: "10px", marginBottom: "10px"}}><div style={{display: "flex", justifyContent: "space-between", alignItems: "center"}}><h3>{review.title}</h3><div style={{display: "flex"}}>{Array(review.rating).fill(0).map((_, index) => <StarIcon key={index} style={{color: "#FFDF00", height: "24px", width: "24px"}} />)}</div></div><small style={{color: "grey"}}>By {review.user_name}</small><div style={{marginTop: "10px", marginBottom: "10px"}}>{review.content}</div><small style={{color: "grey"}}>{review.created_at}</small>{index !== reviews.length - 1 && <hr />}</div>))}</div>//before this</div></div></div>
You first create the modal using
. This modal is opened by the “Add Review” button. When it’s opened, a form with 3 input fields and a textarea is shown to add the review. When the form is submitted, the function passed toCopy to clipboardHyperModal
in the options object ofCopy to clipboardonSubmit
is executed.Copy to clipboarduseFormik
Then, if there are any reviews, you render them one by one.
Test it Out
To run the server for the storefront of your ecommerce website, run the following command:
1npm run dev
This runs the storefront on
. Open it in your browser and choose one of the products. You can see that it has no reviews.Copy to clipboardlocalhost:8000
Click on Add Review to add a review. A modal opens with the form to add a product review.
Fill out the form and click Add. You should be able to see the reviews you add now. Add as many as you want.
Go back to the admin panel and open the page of the product you just added reviews to. You should see the same reviews now on the admin panel.
What’s Next
There’s still much more that you can do in your Medusa server to customize it with all the services and ecommerce features that you need:
- Use Stripe as a Payment Provider
- Integrate your server with Slack for automated notifications whenever a new order is placed.
- Deploy your server on Heroku and your Medusa admin on Netlify.
Should you have any issues or questions related to Medusa, then feel free to reach out to the Medusa team via Discord.
Share this post