crowetic/commerce
1
0
Fork 1
mirror of https://github.com/vercel/commerce.git synced 2025-07-22 12:24:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
commerce/framework/medusa/README.md
Kasper Fabricius Kristensen 3342d9d1bb
initial provider (#2)
2021-09-14 17:29:38 +02:00

2.9 KiB
Raw Blame History

Medusa

Medusa Provider

Medusa is an open-source headless commerce engine that enables developers to create amazing digital commerce experiences.

Medusa is released under the MIT license. PRs welcome! Discord Chat Follow @medusajs

Demo

You can view a working demo of the Medusa provider for Next.js Commerce at https://medusa.vercel.store/

Quickstart

You need a Medusa instance, either in the cloud or self-hosted.

Clone this repo and install dependencies using yarn or npm install

Copy the .env.template file in this directory to .env.local in the main directory (which will be ignored by Git):

mv framework/medusa/.env.template .env.local

Then, set the environment following variables in your .env.local.

  • NEXT_PUBLIC_MEDUSA_STORE_URL must point to the URL where your Medusa instance is running.

  • NEXT_PUBLIC_MEDUSA_IMAGE_HOST must point to your image hosting service.

COMMERCE_PROVIDER=medusa
NEXT_PUBLIC_MEDUSA_STORE_URL=https://medusa-demo.store
NEXT_PUBLIC_MEDUSA_IMG_HOST=medusa-public-images.s3.eu-west-1.amazonaws.com

Notes

  • The entire customer flow is carried out using the Storefront API. This means that there is no existing, pre-built checkout flow. The checkout flow must be built using the Storefront API, for an example of how to do this feel free to have a look at our Next.js starter project.

  • Medusa does not currently support any wishlist features.

  • Medusa does not nativly support searches. This can be implemented using plugins such as MeiliSearch, see #381.

  • Medusa does not come with any page/blog building feature. This can be implemented using Medusa in conjunction with a CMS such as Contentful. For inspiration on how to do this check out our Contentful starter