feat: added npm2yarn package (#1347)

This commit is contained in:
Shahed Nasser
2022-04-18 15:17:27 +02:00
committed by GitHub
parent fcd2889fd7
commit 3ad0f66619
36 changed files with 237 additions and 176 deletions
+5 -1
View File
@@ -6,7 +6,11 @@ title: Checkouts
## Introduction
The purpose of this guide is to describe a checkout flow in Medusa. It is assumed that you've completed our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or [Tutorial](https://docs.medusajs.com/tutorial/set-up-your-development-environment) and are familiar with the technologies we use in our stack. Additionally, having an understanding of the [core API](https://docs.medusajs.com/api/store/auth) would serve as a great foundation for this walkthrough.
> All code snippets in the following guide, use the JS SDK distributed through **npm**. To install it, run `yarn add @medusajs/medusa-js` or `npm install @medusajs/medusa-js`.
> All code snippets in the following guide, use the JS SDK distributed through **npm**. To install it, run:
```bash npm2yarn
npm install @medusajs/medusa-js
```
## Glossary
- **Cart**: The Cart contains all the information needed for customers to complete an Order. In the Cart customers gather the items they wish to purchase, they add shipping and billing details and complete payment information.
+2 -2
View File
@@ -62,7 +62,7 @@ api_secret: "xx"
The first step in creating a plugin is to initialize the Node.js project:
```bash
```bash npm2yarn
npm init
```
@@ -70,7 +70,7 @@ This command will ask you to fill out your project's metadata, which will eventu
Next up, we need to install cloudinary's Node.js SDK.
```bash
```bash npm2yarn
npm install cloudinary
```
+8 -4
View File
@@ -22,7 +22,7 @@ A plugin is essentially a Node.js project of their own. They contain a file in r
The first step in creating a plugin is to initialize the Node.js project:
```bash
```bash npm2yarn
npm init
```
@@ -88,7 +88,11 @@ Official Medusa plugins can be found within the [mono repo](https://github.com/m
Note: For plugins to become a part of the mono repo, we require you to submit a PR request. If approved, we will publish it under the Medusa organisation on Github.
Plugins are distributed as NPM packages making it possible for developers to simply install and use a plugin via `yarn add` or `npm install`.
Plugins are distributed as NPM packages making it possible for developers to simply install and use a plugin via:
```bash npm2yarn
npm install
```
After installing a plugin using your preferred package manager, it should be added to `medusa-config.js`. We allow you to provide options for plugins. These options can be used for anything ranging from provider requirements such as API keys or custom configuration used in the plugin's logic. These options are injected into the services, subscribers, and APIs of the plugin.
@@ -98,8 +102,8 @@ The following steps will install the official Contentful plugin for your Medusa
First, we add the plugin as a dependency to your project:
```bash
yarn add medusa-plugin-contentful
```bash npm2yarn
npm install medusa-plugin-contentful
```
### Step 2: Configuration