Merge pull request #11 from shahednasser/patch-1

chore: general fixes to the readme
This commit is contained in:
Victor Gerbrands 2023-05-12 17:07:56 +02:00 committed by GitHub
commit 9d82379c20
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -18,62 +18,77 @@ A Next.js 13 and App Router-ready ecommerce template, built with [Medusa](https:
## What is Medusa?
[Medusa](https://medusajs.com/) is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any product that needs foundational commerce primitives. All modules are open-source and freely available on npm.
[Medusa](https://medusajs.com/) is a set of commerce modules and tools that allow you to build rich, reliable, and performant commerce applications without reinventing core commerce logic. The modules can be customized and used to build advanced ecommerce stores, marketplaces, or any system that needs foundational commerce primitives. All modules are open-source and freely available on NPM.
Learn more about [Medusas architecture](https://docs.medusajs.com/development/fundamentals/architecture-overview) and [commerce modules](https://docs.medusajs.com/modules/overview) in the Docs.
Learn more about [Medusas architecture](https://docs.medusajs.com/development/fundamentals/architecture-overview) and [commerce modules](https://docs.medusajs.com/modules/overview) in Medusa's documentation.
## Running locally
You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js Commerce. It's recommended you use [Vercel Environment Variables](https://vercel.com/docs/concepts/projects/environment-variables) for this, but a `.env` file is all that is necessary.
You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js Commerce. It's recommended to use [Vercel Environment Variables](https://vercel.com/docs/concepts/projects/environment-variables) for this, but a `.env` file is all that is necessary.
> Note: You should not commit your `.env` file or it will expose secrets.
1. Install Vercel CLI: `npm i -g vercel`
2. Link local instance with Vercel and GitHub accounts (creates `.vercel` directory): `vercel link`
3. Download your environment variables: `vercel env pull`
1\. Install Vercel CLI:
```bash
pnpm install
pnpm dev
npm i -g vercel
```
2\. Link local instance with Vercel and GitHub accounts (which creates a `.vercel` directory):
```bash
vercel link
```
3\. Download your environment variables:
```bash
vercel env pull
```
4\. Install dependencies and run your app:
```bash
npm install
npm run dev
```
Your app should now be running on [localhost:3000](http://localhost:3000/).
## How to configure your Medusa server for Next.js Commerce
## How to configure your Medusa backend for Next.js Commerce
Next.js Commerce x Medusa requires a running [Medusa](https://github.com/medusajs/medusa) server.
Next.js Commerce x Medusa requires a running [Medusa](https://github.com/medusajs/medusa) backend.
### Create a Medusa Backend[](https://docs.medusajs.com/development/backend/install#create-a-medusa-backend 'Direct link to Create a Medusa Backend')
### Prerequisites
It is recommended to use [Yarn](https://yarnpkg.com/getting-started/install) for the installation process as it's much faster than using NPM.
Please refer to the [documentation](https://docs.medusajs.com/development/backend/install#prerequisites) to learn about required tools for the Medusa Backend.
#### 1. Install Medusa CLI[](https://docs.medusajs.com/development/backend/install#1-install-medusa-cli 'Direct link to 1. Install Medusa CLI')
### How to Install the Medusa Backend
```
yarn global add @medusajs/medusa-cli
1\. Install the Medusa CLI tool:
```bash
npm install @medusajs/medusa-cli -g
```
If you run into any errors while installing the CLI tool, check out the [troubleshooting guide](https://docs.medusajs.com/troubleshooting/cli-installation-errors).
2\. Run the following command to create a Medusa backend:
#### 2. Create a new Medusa project[](https://docs.medusajs.com/development/backend/install#2-create-a-new-medusa-project 'Direct link to 2. Create a new Medusa project')
```
medusa new my-medusa-store --seed
```bash
medusa new my-medusa-store https://github.com/medusajs/medusa-starter-default/tree/nextjs-commerce --seed
```
#### 3. Start your Medusa backend[](https://docs.medusajs.com/development/backend/install#3-start-your-medusa-backend 'Direct link to 3. Start your Medusa backend')
3\. Start the Medusa backend:
```
cd my-medusa-store medusa develop
```bash
cd my-medusa-store
medusa develop
```
#### 4. Add Medusa backend domain to an environment variable
4\. Copy the contents of .env.example to a .env file in the root of your Next.js Commerce project, and make sure the NEXT_PUBLIC_MEDUSA_BACKEND_API environment variable points to your Medusa backend domain (default: http://localhost:9000).
Copy the contents of `.env.example` to a `.env` file in the root of your Next.js Commerce project. Make sure the `NEXT_PUBLIC_MEDUSA_BACKEND_API` environment variable points to your Medusa backend domain (default: `http://localhost:9000`).
### (Optional) Install Medusa Admin plugin and add product categories
#### 5. (Optional) Install Medusa Admin plugin and add product categories
Medusa comes with a few demo products, but they won't show up in the template by default. To showcase products in the store, we need to install the Medusa Admin and add a few product categories:
Medusa comes with a few demo products, but they won't show up in the template by default. To showcase products in the store, you need to install the Medusa Admin and add a few product categories. To do that:
1. Install the [Medusa Admin plugin](https://docs.medusajs.com/admin/quickstart)
2. Enable the [Product Categories feature flag](https://docs.medusajs.com/modules/products/categories)