diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..d841939673 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Ask a question + url: https://discord.gg/medusajs + about: Join our community to ask questions and participate in discussions + - name: Want to work with us? + url: mailto:hello@medusajs.com?subject=[GitHub]%20Working%20with%20Medusa + about: Interested in working with Medusa? Get in touch! \ No newline at end of file diff --git a/.github/workflows/docs-test.yml b/.github/workflows/docs-test.yml new file mode 100644 index 0000000000..123b5f77aa --- /dev/null +++ b/.github/workflows/docs-test.yml @@ -0,0 +1,31 @@ +name: Docusaurus Documentation Test +on: + pull_request: + paths: + - docs/content/** + - www/docs/** +jobs: + docs-test: + runs-on: ubuntu-latest + steps: + - name: Cancel Previous Runs + uses: styfle/cancel-workflow-action@0.9.1 + with: + access_token: ${{ github.token }} + + - name: Checkout + uses: actions/checkout@v2.3.5 + with: + fetch-depth: 0 + + - name: Setup Node.js environment + uses: actions/setup-node@v2.4.1 + with: + node-version: "14" + cache: "yarn" + + - name: Build Docusaurus website + run: | + cd www/docs + yarn install + yarn build diff --git a/docs/content/admin/quickstart.md b/docs/content/admin/quickstart.md index eba14beb8b..86c1f24c46 100644 --- a/docs/content/admin/quickstart.md +++ b/docs/content/admin/quickstart.md @@ -1,10 +1,4 @@ ---- - -title: Medusa Admin Quickstart - ---- - -# Admin Quickstart +# Medusa Admin Quickstart This document will guide you through setting up the Medusa admin in minutes, as well as some of its features. @@ -18,6 +12,12 @@ If you’re not very familiar with Medusa’s architecture, you can learn more a ::: + + ## Install the Admin Start by cloning the [Admin GitHub repository](https://github.com/medusajs/admin) and changing to the cloned directory: @@ -154,4 +154,4 @@ In the Medusa admin, you can manage your store’s overall settings. These inclu ## What’s Next 🚀 - Install the [Next.js](../starters/nextjs-medusa-starter.md) or [Gatsby](../starters/gatsby-medusa-starter.md) storefront starters. -- [Learn how you can use `create-medusa-app` to install all of Medusa’s 3 components.](../how-to/create-medusa-app.md) +- [Learn how you can use `create-medusa-app` to install all of Medusa’s 3 components.](../usage/create-medusa-app.mdx) diff --git a/docs/content/cli/reference.md b/docs/content/cli/reference.md new file mode 100644 index 0000000000..9dc1f83149 --- /dev/null +++ b/docs/content/cli/reference.md @@ -0,0 +1,206 @@ +# CLI Reference + +This document serves as a reference to the Medusa CLI tool including how to install it and what commands are available. + +## Overview + +The Medusa CLI serves as a tool that allows you to perform important commands while developing with Medusa. + +To use Medusa, it is required to install the CLI tool as it is used to create a new Medusa server. + +## How to Install CLI Tool + +To install the CLI tool, run the following command in your terminal: + +```bash npm2yarn +npm install @medusajs/medusa-cli -g +``` + +The CLI tool is then available under the `medusa` command. You can see all commands and options with the following command: + +```bash +medusa --help +``` + +## Common Options + +The following options can be used with all available commands. + +### --help + +Learn more about what you can do with the CLI tool or with a specific command. + +**Alias:** `-h` + +```bash +medusa new --help +``` + +### --verbose + +Turn on verbose output for detailed logs. + +**Default:** `false` + +```bash +medusa new test-server --verbose +``` + +### --no-color + +Turn off colors in the output. + +**Alias:** `--no-colors` + +**Default:** `false` + +```bash +medusa new test-server --no-color +``` + +### --json + +Turn on JSON logger. + +**Default:** `false` + +```bash +medusa new test-server --json +``` + +### --version + +If used inside a Medusa project, the version of the Medusa CLI and Medusa project is shown. Otherwise, the version of the Medusa CLI is shown. + +**Alias:** `-v` + +```bash +medusa --version +``` + +## Available Commands + +### new + +Create a new Medusa server. + +```bash +medusa new [ []] +``` + +#### Arguments + +| Name | Description | Default | +| --- | --- | --- | +| `server_name` | The name of the Medusa server. It will be used as the name of the directory created. | If not provided, you’ll be prompted to enter it. | +| `starter_url` | The URL of the starter to create the server from. | The default starter is used. | + +#### Options + +| Name | Description | +| --- | --- | +| `--seed` | If the flag is set the command will attempt to seed the database after setup. | +| `-y`, `--useDefaults` | If the flag is set the command will not interactively collect database credentials. | +| `--skip-db` | If the flag is set the command will not attempt to complete the database setup. | +| `--skip-migrations` | If the flag is set the command will not attempt to complete the database migration. | +| `--skip-env` | If the flag is set the command will not attempt to populate .env. | +| `--db-user` | The database user to use for database setup and migrations. | +| `--db-database` | The database used for database setup and migrations. | +| `--db-pass` | The database password to use for database setup and migrations. | +| `--db-port` | The database port to use for database setup and migrations. | +| `--db-host` | The database host to use for database setup and migrations. | + +### develop + +Start development server. This command watches files for any changes to rebuild the files and restart the server. + +```bash +medusa develop +``` + +#### Options + +| Name | Description | +| --- | --- | +| `-H`, `--host` | Set host. Defaults to localhost. | +| `-p`, `--port` | Set port. Defaults to 9000. | + +### start + +Start development server. This command does not watch for file changes or restart the server. + +```bash +medusa start +``` + +#### Options + +| Name | Description | +| --- | --- | +| `-H`, `--host` | Set host. Defaults to localhost. | +| `-p`, `--port` | Set port. Defaults to 9000. | + +### migrations + +Migrate the database to the most recent version. + +```bash +medusa migrations +``` + +#### Arguments + +| Name | Description | Default | +| --- | --- | --- | +| `action` | The action to perform. Values can be run or show. run is used to run the migrations, and show is used to only show what migrations are available to run. | This argument is required and does not have a default value. | + +### seed + +Migrates and populates the database with the provided file. + +```bash +medusa seed --seed-file= +``` + +#### Options + +| Name | Description | +| --- | --- | +| `-f`, `--seed-file` | Path to the file where the seed is defined. (required) | +| `-m`, `--migrate` | Flag to indicate if migrations should be run prior to seeding the database. Default is true. | + +### user + +Creates a new admin user. + +```bash +medusa user --email [--password ] +``` + +#### Options + +| Name | Description | +| --- | --- | +| `-e`, `--email` | The email to create a user with. (required) | +| `-p`, `--password` | The password to use with the user. If not included, the user will not have a password. | +| `-i`, `--id` | The user’s ID. By default it is automatically generated. | + +### telemetry + +Enable or disable the collection of anonymous data usage. If no option is provided, the command will enable the collection of anonymous data usage. + +```bash +medusa telemetry +``` + +#### Options + +| Name | Description | +| --- | --- | +| `--enable` | Enable telemetry (default) | +| `--disable` | Disable telemetry | + +## What’s Next 🚀 + +- Learn more about [anonymous usage data collection](../usage.md). +- Learn how to [configure your Medusa server](../usage/configurations.md). diff --git a/docs/content/deployments/admin/deploying-on-netlify.md b/docs/content/deployments/admin/deploying-on-netlify.md new file mode 100644 index 0000000000..2496fb1554 --- /dev/null +++ b/docs/content/deployments/admin/deploying-on-netlify.md @@ -0,0 +1,276 @@ +# Deploy Medusa Admin on Netlify + +In this document, you’ll learn how to deploy the Medusa Admin on [Netlify](https://www.netlify.com/). + + + +## Prerequisites + +### Medusa Components + +Before proceeding with this documentation, it is assumed you already have a Medusa Admin installed locally. If not, please go through the [quickstart guide](../../admin/quickstart.md) first. + +Additionally, this documentation does not cover how to deploy the Medusa server. If you want to deploy the Medusa server, check out one of the [deployment documentation related to the Medusa server](../server/index.mdx). + +### Needed Accounts + +You need a Netlify account to deploy the Medusa Admin. If you don’t have one, you can create one on [Netlify’s website](https://app.netlify.com/signup?_ga=2.249228995.556918419.1656505909-2004101041.1655191129). + +Additionally, you need a GitHub account where you will host the repository for the Medusa admin. You can create it on [GitHub’s website](https://github.com/signup). + +:::tip + +If you want to use another Git Provider, it’s possible to follow along with this guide but you’ll have to perform the equivalent steps in your Git Provider. + +::: + +### Required Tools + +Git’s CLI tool is required while following along with this tutorial. You can follow [this documentation to learn how to install it for your operating system](../../tutorial/0-set-up-your-development-environment.mdx#git). + +## Create GitHub Repository + +Before you can deploy your Medusa Admin you need to create a GitHub repository and push the code base to it. + +On GitHub, click the plus icon at the top right, then click New Repository. + +![Create Repository](https://i.imgur.com/0YlxBRi.png) + +You’ll then be redirected to a new page with a form. In the form, enter the Repository Name then scroll down and click Create repository. + +![Repository Form](https://i.imgur.com/YPYXAF2.png) + +### Push Code to GitHub Repository + +The next step is to push the code to the GitHub repository you just created. + +After creating the repository, you’ll be redirected to the repository’s page. On that page, you should see a URL that you can copy to connect your repository to a local directory. + +![GitHub Repository URL](https://i.imgur.com/pHfSTuT.png) + +Copy the link. Then, open your terminal in the directory that holds your Medusa Admin codebase and run the following commands: + +```bash +git init +git remote add origin +``` + +Where `` is the URL you just copied. + +Then, add, commit, and push the changes into the repository: + +```bash +git add . +git commit -m "initial commit" +git push origin master +``` + +After pushing the changes, you can find the files in your GitHub repository. + +## Deploy to Netlify + +This section covers how to deploy Netlify either through the Netlify website or using Netlify’s CLI tool. + +### Option 1: Using Netlify’s Website + +After logging in with Netlify, go to the [dashboard](https://app.netlify.com/). Then, at the top right of the “Sites” section, click on “Add new site”, then click on “Import an existing project” from the dropdown. + +:::note + +Alternatively, if you don’t have any other websites, you’ll see a big button that says “Import an existing project”. + +::: + +![Create a new website](https://i.imgur.com/IUUOzoW.png) + +You’ll then be asked to connect to a Git provider. + +![Connect Git Provider](https://i.imgur.com/T6lZPDi.png) + +Choose GitHub. You’ll then be redirected to GitHub’s website to give Netlify permissions if you haven’t done that before. + +After you authorize Netlify to use GitHub, you’ll be asked to pick the repository you want to deploy. Pick the repository you just created. + +![Choose Repository](https://i.imgur.com/D0r6Q1e.png) + +In the form that shows, keep all fields the same and click on the “Show advanced” button before the “Deploy site” button. + +![Show advanced Button](https://i.imgur.com/nUdwRbq.png) + +Under the “Advanced build settings” section click on the “New variable” button. This will show 2 inputs for the key and value of the environment variable. + +For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server. + +:::caution + +If you haven’t deployed your Medusa server yet, you can leave the value blank for now and add it later. However, you will not be able to log in to the Medusa Admin without deploying the Medusa server. + +::: + +![Environment Variable](https://i.imgur.com/DnutZfT.png) + +Once you’re done, scroll down and click on Deploy site. + +You’ll be then redirected to the dashboard of the new website. Netlify will build your website in the background. You should see “Site deploy in progress” on the top card. + +![Site Deployment Progress](https://i.imgur.com/BCnLPw7.png) + +The deployment can take a few minutes. + +Once the deployment is done, you’ll find the URL in the place of the “Site deploy in progress” message you saw earlier. + +![Deployment Complete](https://i.imgur.com/fNBxCG2.png) + +If you click on it, you’ll be redirected to the deployed admin website. + +![Medusa Admin Login](https://i.imgur.com/6t4ODe4.png) + +:::note + +Before you can use Medusa Admin, you must add the URL as an environment variable on your deployed Medusa server. Follow along in the [Configure CORS on the Medusa Server](#configure-cors-variable-on-the-medusa-server) section. + +::: + +### Option 2: Using Netlify’s CLI Tool + +In this section, you’ll deploy the Medusa Admin using Netlify’s CLI tool. + +#### Install the Netlify CLI tool + +If you don’t have the tool installed, run the following command to install it: + +```bash +npm install netlify-cli -g +``` + +#### Login to Netlify + +Then, run the following command to log in to Netlify in your terminal: + +```bash +netlify login +``` + +This opens a page to log in on your browser. You’ll be asked to authorize the Netlify CLI tool. + +![Authorize Application](https://i.imgur.com/JDUdqSE.png) + +Click on Authorize. Then, you can go back to your terminal and see that you’ve successfully logged in. + +![Authorized Message](https://i.imgur.com/L13Yqhp.png) + +#### Initialize Netlify Website + +In your terminal, run the following command: + +```bash +netlify init +``` + +You’ll have to follow 5 steps for the initialization: + +##### **Step 1: Create Netlify Website** + +You’ll be asked to either connect to an existing Netlify website or create a new one. Choose the second option to create a new site: + +```bash +? What would you like to do? + ⇄ Connect this directory to an existing Netlify site +❯ + Create & configure a new site +``` + +##### Step 2: Choose Netlify Team + +Choose the team you want to create the website in if you have multiple teams. + +##### Step 3: Enter Site Name + +You’ll be asked to optionally enter a site name. + +##### Step 4: Configure Webhooks and Deployment Keys + +At this point, the website is created on Netlify. However, Netlify needs to configure Webhooks and deployment keys. You’ll be asked to either authorize GitHub through Netlify’s website or through a personal access token. You’re free to choose either: + +```bash +? Netlify CLI needs access to your GitHub account to configure Webhooks and Depl +oy Keys. What would you like to do? (Use arrow keys) +❯ Authorize with GitHub through app.netlify.com + Authorize with a GitHub personal access token +``` + +If you pick the first option, a page in your browser will open where you have to grant authorization to your Git provider. + +If you pick the second option, you’ll need to create a personal access token on GitHub. You can follow [this guide in GitHub’s documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to learn how to do it. + +##### Last Step: Steps with Default Values + +For the rest of the steps, you can keep the default values provided by Netlify and press the “Enter” key on your keyboard for each. + +#### Set Environment Variables + +After the previous command has finished running, your Netlify website will be created. The next step is to add an environment variable that points to your Medusa server. + +:::caution + +If you haven’t deployed your Medusa server yet, you can leave the value blank for now and add it later. However, you will not be able to log in to the dashboard or use it without deploying the Medusa server. + +::: + +Run the following command to add the environment variable: + +```bash +netlify env:set GATSBY_MEDUSA_BACKEND_URL "" +``` + +Where `` is the URL of your Medusa server. + +#### Check deployment status + +You can check the deployment status of your website by running the following command: + +```bash +netlify watch +``` + +After the deployment has been completed, you should see a message saying “Deploy complete” with URLs to your website. + +#### Open Medusa Admin Website + +To open the Medusa Admin website, either use the URL shown to you or run the following command: + +```bash +netlify open:site +``` + +The Medusa Admin will then open in your browser. + +![Medusa Admin Login](https://i.imgur.com/6t4ODe4.png) + +Before you can use Medusa Admin, you must add the URL as an environment variable on your deployed Medusa server. + +## Configure CORS Variable on the Medusa Server + +To send requests to the Medusa server from the Medusa Admin, you must set the `ADMIN_CORS` environment variable on your server to the Medusa Admin’s URL. + +:::caution + +If you want to set a custom domain to your Medusa Admin website on Netlify, make sure to do it before this step. You can refer to this guide on [Netlify’s documentation to learn how to add a custom domain](https://docs.netlify.com/domains-https/custom-domains/#assign-a-domain-to-a-site). + +::: + +On your Medusa server, add the following environment variable: + +```bash +ADMIN_CORS= +``` + +Where `` is the URL of your Medusa Admin that you just deployed. + +Then, restart your Medusa server. Once the server is running again, you can log in to the Medusa Admin and use it. + +## What’s Next 🚀 + +- Learn how to [deploy your storefront](../storefront/index.mdx). +- Learn more about [how you can configure Medusa](../../usage/configurations.md). diff --git a/docs/content/deployments/admin/index.mdx b/docs/content/deployments/admin/index.mdx new file mode 100644 index 0000000000..87ca5fa04c --- /dev/null +++ b/docs/content/deployments/admin/index.mdx @@ -0,0 +1,8 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# Medusa Admin Deployment Guides + +Find in this page guides to deploy your Medusa Admin on different platforms. + + \ No newline at end of file diff --git a/docs/content/deployments/deployment.module.css b/docs/content/deployments/deployment.module.css new file mode 100644 index 0000000000..f649207965 --- /dev/null +++ b/docs/content/deployments/deployment.module.css @@ -0,0 +1,10 @@ +.osTabs { + background-color: #f4f4f4; + padding: 10px; + border-radius: 6.4px; + color: #000; +} + +.osTabs li:not([aria-selected=true]) { + color: #000; +} \ No newline at end of file diff --git a/docs/content/how-to/deploying-on-digital-ocean.md b/docs/content/deployments/server/deploying-on-digital-ocean.md similarity index 96% rename from docs/content/how-to/deploying-on-digital-ocean.md rename to docs/content/deployments/server/deploying-on-digital-ocean.md index ecfb8a120e..7482436c32 100644 --- a/docs/content/how-to/deploying-on-digital-ocean.md +++ b/docs/content/deployments/server/deploying-on-digital-ocean.md @@ -4,7 +4,7 @@ This is a guide for deploying a Medusa project on DigitalOcean App Platform. :::note -It is assumed, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. +It is assumed, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](../../usage/create-medusa-app.mdx) for a small walkthrough. ::: @@ -175,5 +175,5 @@ You now have an application running on DigitalOcean. This can be scaled and conf Furthermore, you can deploy a Medusa Admin for your application, such that you can start managing your store from an interface. -- [Deploy Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) +- [Deploy Admin on Netlify](../admin/deploying-on-netlify.md) - Deploy Admin on Gatsby Cloud (Coming soon) diff --git a/docs/content/deployments/server/deploying-on-heroku.mdx b/docs/content/deployments/server/deploying-on-heroku.mdx new file mode 100644 index 0000000000..76f2d2ba79 --- /dev/null +++ b/docs/content/deployments/server/deploying-on-heroku.mdx @@ -0,0 +1,273 @@ +import styles from '../deployment.module.css'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Deploy Your Medusa Server on Heroku + +In this document, you'll learn how to deploy your Medusa server on Heroku. Heroku is a PaaS (Platform as a Service) that allows you to easily deploy your applications in the cloud. + +
+ +
+ +## Prerequisites + +Before you start with this guide, you must have a Medusa server installed locally. + +To install a Medusa server, follow our [Quickstart guide](../../quickstart/quick-start.md). + +## How to Deploy Your Medusa Server on Heroku + +### 1. Install the Heroku CLI + +Install the Heroku CLI tool using the instructions that belong to your operating system. + + + + +Download the appropriate installer for your Windows installation: + +[64-bit installer](https://cli-assets.heroku.com/heroku-x64.exe) + +[32-bit installer](https://cli-assets.heroku.com/heroku-x86.exe) + + + + +For Ubuntu, you can use the following command: + +```bash +sudo snap install --classic heroku +``` + +As for other Linux distributions, please check [Heroku's guide](https://devcenter.heroku.com/articles/heroku-cli#standalone-installation-with-a-tarball). + + + + +For macOS you can install Heroku's CLI tool using Homebrew: + +```bash +brew tap heroku/brew && brew install heroku +``` + +For other installation options, please check [Heroku's guide](https://devcenter.heroku.com/articles/heroku-cli#standalone-installation-with-a-tarball) + + + + +### 2. Login to Heroku from your CLI + +Before you can create an app with Heroku, you must login with the CLI tool: + +```bash +heroku login +``` + +Depending on your operating system, you must follow either the instructions in your terminal or a page in your browser will open. + +### 3. Create an App with Heroku + +In the root directory of your Medusa server, run the following commands to create an app on Heroku and add it as a remote origin: + +```bash +heroku create +heroku git:remote -a +``` + +Where `` is the name of the app you'll create. You can use any name you want. + +### 4. Install Postgresql and Redis on Heroku + +Medusa requires a Postgres database and a Redis instance to work. You can add those to your Heroku app using Add-ons. + +:::tip + +In this section, the add-ons are used with a free plan. It's highly recommended that you don't use a free plan in a production environment. + +::: + +#### PostgreSQL + +Add a Postgres add-on to your Heroku app with the following command: + +:::note + +This add-on is added with a free plan. However, Heroku might require you to add a payment method to proceed. + +::: + +```bash +heroku addons:create heroku-postgresql:hobby-dev +``` + +This uses the free plan of Heroku Postgres. Make sure to check out [more information regarding the plans and pricing of Heroku Postgres](https://elements.heroku.com/addons/heroku-postgresql#pricing). + +#### Redis + +:::note + +The Add-on used here for Redis is [Upstash](https://devcenter.heroku.com/articles/upstash-redis) which is currently in beta. However, it provides a generous free plan. You can alternatively go for [Stackhero](https://elements.heroku.com/addons/stackhero-redis) but it does not have a free plan. + +::: + +Add a Redis instance to your Heroku app with the following command: + +:::note + +This add-on is added with a free plan. However, Heroku might require you to add a payment method to proceed. + +::: + +```bash +heroku addons:create upstash-redis +``` + +This uses the free plan of Upstash. Make sure to check out [more information regarding the plans and pricing of Upstash](https://elements.heroku.com/addons/upstash-redis#pricing). + +### 5. Configure Environment Variables on Heroku + +Medusa requires a set of environment variables to be configured. You can learn more about Medusa's configurations in the [Configure your Medusa Server](../../usage/configurations.md) document. + +Run the following commands in the root directory of your Medusa server to set some environment variables: + +```bash +heroku config:set NODE_ENV=production +heroku config:set JWT_SECRET=your-super-secret +heroku config:set COOKIE_SECRET=your-super-secret-pt2 +heroku config:set NPM_CONFIG_PRODUCTION=false +``` + +:::tip + +Make sure to replace `your-super-secret` and `your-super-secret-pt2` with actual secrets in a production environment. + +::: + +#### Set Buildpack + +Additionally, you need to set the buildpack to Node.js using the following command: + +```bash +heroku buildpacks:set heroku/nodejs +``` + +#### Configure the Redis URL + +Upstash adds the Redis URL under the environment variable `UPSTASH_REDIS_URL`. However, Medusa looks for the `REDIS_URL` environment variable when initializing the connection with Redis. + +So, retrieve the value of `UPSTASH_REDIS_URL` with the following command: + +```bash +heroku config:get UPSTASH_REDIS_URL +``` + +This prints the value of the environment variable which is a Redis connection string. + +Copy that value and use it to set the environment variable `REDIS_URL` with the following command: + +```bash +heroku config:set REDIS_URL= +``` + +Where `` is the value you received from the previous command. + +#### Configure the PostgreSQL Database URL + +If you're using the Heroku PostgreSQL Add-on, it should configure the environment variable `DATABASE_URL`. So, you don't need to perform any additional actions. + +However, if you use another add-on, make sure to set the environment variable `DATABASE_URL` to the PostgreSQL Database URL. + +#### (Optional) Configure CORS Variables + +Optionally, if you've deployed the admin dashboard and you want to ensure it can use the server's REST APIs, you must set the following environment variable: + +```bash +heroku config:set ADMIN_CORS= +``` + +Where `` is the URL of your admin dashboard. + +Similarly, if you've deployed the storefront and you want to ensure it can use the server's REST APIs, you must set the following environment variable: + +```bash +heroku config:set STORE_CORS= +``` + +Where `` is the URL of your storefront. + +### 6. Configure Medusa Server + +Before jumping into the deployment, you need to configure your Medusa server to ensure it uses the previous environment variables and the recommended production configurations. + +#### medusa-config.js + +Update `module.exports` to include the following configurations: + +```js +module.exports = { + projectConfig: { + redis_url: REDIS_URL, + database_url: DATABASE_URL, + database_type: "postgres", + store_cors: STORE_CORS, + admin_cors: ADMIN_CORS, + database_extra: + process.env.NODE_ENV !== "development" + ? { ssl: { rejectUnauthorized: false } } + : {}, + }, + plugins, +}; +``` + +#### package.json + +Update `scripts` to include the following scripts: + +```json +"scripts": { + "serve": "medusa start", + "start": "medusa develop", + "heroku-postbuild": "medusa migrations run", + "prepare": "npm run build", + "build": "babel src -d dist --extensions \".ts,.js\"" +}, +``` + +### 7. Launch your Medusa Server + +Finally, commit and push all changes to Heroku: + +```bash +git add . +git commit -m "Deploy Medusa Server on Heroku" +git push heroku HEAD:master +``` + +This triggers a redeploy of the Medusa server with all the new configurations. + +## Troubleshooting: Inspect Build Logs + +If an error occurs during the deployment, you can explore your Heroku app build logs using the following command in the root directory of your Medusa server: + +```bash +heroku logs -n 500000 --remote heroku --tail +``` + +## Create a User + +As an optional extra step, you can create a user to use when your admin dashboard is up and running: + +```bash +heroku run -a -- medusa user -e "" -p "" +``` + +Where `` is the name of your Heroku app, and `` and `` are the credentials you want to use to log in to the Medusa admin dashboard. + +## What's Next :rocket: + +- Learn how to [deploy your Medusa admin](../admin/index.mdx). +- Learn how to [deploy your storefront](../storefront/index.mdx). diff --git a/docs/content/how-to/deploying-on-qovery.md b/docs/content/deployments/server/deploying-on-qovery.md similarity index 95% rename from docs/content/how-to/deploying-on-qovery.md rename to docs/content/deployments/server/deploying-on-qovery.md index 811691a983..e2a4f990b0 100644 --- a/docs/content/how-to/deploying-on-qovery.md +++ b/docs/content/deployments/server/deploying-on-qovery.md @@ -4,7 +4,7 @@ This is a guide for deploying a Medusa project to Qovery. Qovery is a Continuous :::note -We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. +We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](../../usage/create-medusa-app.mdx) for a small walkthrough. ::: @@ -134,5 +134,5 @@ You now have an application running on Qovery. This can be scaled and configured Furthermore, you can deploy Medusa Admin for your application, such that you can start managing your store from an interface. -- [Deploy Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) +- [Deploy Admin on Netlify](../admin/deploying-on-netlify.md) - Deploy Admin on Gatsby Cloud (Coming soon) diff --git a/docs/content/deployments/server/index.mdx b/docs/content/deployments/server/index.mdx new file mode 100644 index 0000000000..f94f4e6bb0 --- /dev/null +++ b/docs/content/deployments/server/index.mdx @@ -0,0 +1,8 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# Medusa Server Deployment Guides + +Find in this page guides to deploy your Medusa server on different platforms. + + \ No newline at end of file diff --git a/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md b/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md new file mode 100644 index 0000000000..7263edcade --- /dev/null +++ b/docs/content/deployments/storefront/deploying-gatsby-on-netlify.md @@ -0,0 +1,300 @@ +# Deploy Gatsby Storefront on Netlify + +In this document, you’ll learn how to deploy the Gatsby Storefront on [Netlify](https://www.netlify.com/). + + + +## Prerequisites + +### Medusa Components + +Before proceeding with this documentation, it is assumed you already have the Gatsby storefront installed locally. If not, please go through the [quickstart guide](../../starters/gatsby-medusa-starter.md) first. + +Additionally, this documentation does not cover how to deploy the Medusa server. If you want to deploy the Medusa server, [check out one of the deployment documentation related to the Medusa server](../server/index.mdx). + +### Needed Accounts + +You need a Netlify account to deploy the Gatsby storefront. If you don’t have one, you can create one on [Netlify’s website](https://app.netlify.com/signup). + +Additionally, you need a GitHub account where you will host the repository for the Gatsby storefront. You can create it on [GitHub’s website](https://github.com/signup). + +:::tip + +If you want to use another Git Provider, it’s possible to follow along with this guide but you’ll have to perform the equivalent steps in your Git Provider. + +::: + +### Required Tools + +Git’s CLI tool is required while following along with this tutorial. You can follow [this documentation to learn how to install it for your operating system](../../tutorial/0-set-up-your-development-environment.mdx#git). + +## Create GitHub Repository + +Before you can deploy your Gatsby storefront you need to create a GitHub repository and push the code base to it. + +On GitHub, click the plus icon at the top right, then click New Repository. + +![Create Repository](https://i.imgur.com/0YlxBRi.png) + +You’ll then be redirected to a new page with a form. In the form, enter the Repository Name then scroll down and click Create repository. + +![Repository Form](https://i.imgur.com/YPYXAF2.png) + +### Push Code to GitHub Repository + +The next step is to push the code to the GitHub repository you just created. + +After creating the repository, you’ll be redirected to the repository’s page. On that page, you should see a URL that you can copy to connect your repository to a local directory. + +![GitHub Repository URL](https://i.imgur.com/pHfSTuT.png) + +Copy the link. Then, open your terminal in the directory that holds your Gatsby storefront codebase and run the following commands: + +```bash +git init +git remote add origin +``` + +Where `` is the URL you just copied. + +Then, add, commit, and push the changes into the repository: + +```bash +git add . +git commit -m "initial commit" +git push origin master +``` + +After pushing the changes, you can find the files in your GitHub repository. + +## Deploy to Netlify + +This section covers how to deploy Netlify either through the Netlify website or using Netlify’s CLI tool. + +### Option 1: Using Netlify’s Website + +After logging in with Netlify, go to the [dashboard](https://app.netlify.com/). Then, at the top right of the “Sites” section, click on “Add new site”, then click on “Import an existing project” from the dropdown. + +:::note + +Alternatively, if you don’t have any other websites, you’ll see a big button that says “Import an existing project”. + +::: + +![Create a new website](https://i.imgur.com/IUUOzoW.png) + +You’ll then be asked to connect to a Git provider. + +![Connect Git Provider](https://i.imgur.com/T6lZPDi.png) + +Choose GitHub. You’ll then be redirected to GitHub’s website to give Netlify permissions if you haven’t done that before. + +After you authorize Netlify to use GitHub, you’ll be asked to pick the repository you want to deploy. Pick the repository you just created. + +![Choose Repository](https://i.imgur.com/SRI3r1Y.png) + +In the form that shows, keep all fields the same and click on the “Show advanced” button before the “Deploy site” button. + +![Show advanced Button](https://i.imgur.com/nUdwRbq.png) + +Under the “Advanced build settings” section click on the “New variable” button. This will show 2 inputs for the key and value of the environment variable. + +For the first field enter the key `GATSBY_MEDUSA_BACKEND_URL` and for the value enter the URL of your Medusa server. + +:::caution + +If you haven’t deployed your Medusa server yet, you can leave the value blank for now and add it later. However, the build process for the Gatsby storefront will fail. + +::: + +![Environment Variable](https://i.imgur.com/DnutZfT.png) + +Once you’re done, scroll down and click on Deploy site. + +You’ll be then redirected to the dashboard of the new website. Netlify will build your website in the background. You should see “Site deploy in progress” on the top card. + +![Site Deployment Progress](https://i.imgur.com/PUDjjnL.png) + +The deployment can take a few minutes. + +Once the deployment is done, you’ll find the URL in the place of the “Site deploy in progress” message you saw earlier. + +:::tip + +If you haven’t added any products to your Medusa server, the build process might fail. It’s recommended to add some products to the server first in that case. + +Alternatively, you can seed the server with demo data by running this command in the root directory of the server: + +```bash +medusa seed -f data/seed.json +``` + +::: + +![Deployment Complete](https://i.imgur.com/dPF9HvF.png) + +If you click on it, you’ll be redirected to the deployed storefront website. + +![Gatsby Storefront](https://i.imgur.com/l08cBSA.png) + +:::caution + +At this point, you will face errors related to CORS while using the storefront. Before you start using the storefront, follow along the [Configure CORS on the Medusa Server section](#configure-cors-variable-on-the-medusa-server). + +::: + +### Option 2: Using Netlify’s CLI Tool + +In this section, you’ll deploy the Gatsby storefront using Netlify’s CLI tool. + +#### Install the Netlify CLI tool + +If you don’t have the tool installed, run the following command to install it: + +```bash +npm install netlify-cli -g +``` + +#### Login to Netlify + +Then, run the following command to log in to Netlify in your terminal: + +```bash +netlify login +``` + +This opens a page to log in on your browser. You’ll be asked to authorize the Netlify CLI tool. + +![Authorize Application](https://i.imgur.com/JDUdqSE.png) + +Click on Authorize. Then, you can go back to your terminal and see that you’ve successfully logged in. + +![Authorized Message](https://i.imgur.com/L13Yqhp.png) + +#### Initialize Netlify Website + +In your terminal, run the following command: + +```bash +netlify init +``` + +You’ll have to follow 5 steps for the initialization: + +##### Step 1: Create Netlify Website + +You’ll be asked to either connect to an existing Netlify website or create a new one. Choose the second option to create a new site: + +```bash +? What would you like to do? + ⇄ Connect this directory to an existing Netlify site +❯ + Create & configure a new site +``` + +##### Step 2: Choose Netlify Team + +Choose the team you want to create the website in if you have multiple teams. + +##### Step 3: Enter Site Name + +You’ll be asked to optionally enter a site name. + +##### Step 4: Configure Webhooks and Deployment Keys + +At this point, the website is created on Netlify. However, Netlify needs to configure Webhooks and deployment keys. You’ll be asked to either authorize GitHub through Netlify’s website or through a personal access token. You’re free to choose either: + +```bash +? Netlify CLI needs access to your GitHub account to configure Webhooks and Depl +oy Keys. What would you like to do? (Use arrow keys) +❯ Authorize with GitHub through app.netlify.com + Authorize with a GitHub personal access token +``` + +If you pick the first option, a page in your browser will open where you have to grant authorization to your Git provider. + +If you pick the second option, you’ll need to create a personal access token on GitHub. You can follow [this guide in GitHub’s documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to learn how to do it. + +##### Last Step: Steps with Default Values + +For the rest of the steps, you can keep the default values provided by Netlify and press the “Enter” key on your keyboard for each. + +#### Set Environment Variables + +After the previous command has finished running, your Netlify website will be created. The next step is to add an environment variable that points to your Medusa server. + +:::caution + +If you haven’t deployed your Medusa server yet, you can leave the value blank for now and add it later. However, the build process for the Gatsby storefront will fail. + +::: + +Run the following command to add the environment variable: + +```bash +netlify env:set GATSBY_MEDUSA_BACKEND_URL "" +``` + +Where `` is the URL of your Medusa server. + +#### Check deployment status + +You can check the deployment status of your website by running the following command: + +```bash +netlify watch +``` + +After the deployment has been completed, you should see a message saying “Deploy complete” with URLs to your website. + +:::tip + +If you haven’t added any products to your Medusa server, the build process might fail. It’s recommended to add some products to the server first in that case. + +Alternatively, you can seed the server with demo data by running this command in the root directory of the server: + +```bash +medusa seed -f data/seed.json +``` + +::: + +#### Open the Gatsby storefront Website + +To open the Gatsby storefront website, either use the URL shown to you or run the following command: + +```bash +netlify open:site +``` + +The Gatsby storefront will then open in your browser. + +![Gatsby Storefront](https://i.imgur.com/l08cBSA.png) + +Before you can use the Gatsby storefront, you must add the URL as an environment variable on your deployed Medusa server. + +## Configure CORS Variable on the Medusa Server + +To send requests to the Medusa server from the Gatsby storefront, you must set the `STORE_CORS` environment variable on your server to the Gatsby storefront’s URL. + +:::caution + +If you want to set a custom domain to your Gatsby storefront website on Netlify, make sure to do it before this step. You can refer to this guide on [Netlify’s documentation to learn how to add a custom domain](https://docs.netlify.com/domains-https/custom-domains/#assign-a-domain-to-a-site). + +::: + +On your Medusa server, add the following environment variable: + +```bash +STORE_CORS= +``` + +Where `` is the URL of your Gatsby storefront that you just deployed. + +Then, restart your Medusa server. Once the server is running again, you can use your Gatsby storefront. + +## What’s Next 🚀 + +- Learn how to [deploy the Medusa Admin](../admin/index.mdx). +- Learn more about [Medusa’s configurations](../../usage/configurations.md). diff --git a/docs/content/deployments/storefront/index.mdx b/docs/content/deployments/storefront/index.mdx new file mode 100644 index 0000000000..54df5ae36b --- /dev/null +++ b/docs/content/deployments/storefront/index.mdx @@ -0,0 +1,8 @@ +import DocCardList from '@theme/DocCardList'; +import {useCurrentSidebarCategory} from '@docusaurus/theme-common'; + +# Storefront Deployment Guides + +Find in this page guides to deploy your storefront on different platforms. + + \ No newline at end of file diff --git a/docs/content/homepage.md b/docs/content/homepage.md index 935c0c0229..b5f0091167 100644 --- a/docs/content/homepage.md +++ b/docs/content/homepage.md @@ -62,7 +62,7 @@ Alternatively, you can build your own storefront with any frontend framework of - Customize your Medusa server by creating your own [endpoints](./advanced/backend/endpoints/add-storefront.md), [services](./advanced/backend/services/create-service.md), and [subscribers](./advanced/backend/subscribers/create-subscriber.md). - Check out guides under the Integrations section to install plugins for [CMS](./add-plugins/strapi.md), [Payment](./add-plugins/stripe.md), [Search Engines](./add-plugins/algolia.md), and more. -- Deploy your Medusa server in seconds on [Heroku](./how-to/deploying-on-heroku.md), [Qovery](./how-to/deploying-on-qovery.md), or [Digital Ocean](./how-to/deploying-on-digital-ocean.md). +- Deploy your Medusa server in seconds on [Heroku](deployments/server/deploying-on-heroku.mdx), [Qovery](deployments/server/deploying-on-qovery.md), or [Digital Ocean](deployments/server/deploying-on-digital-ocean.md). ## Open Source Contribution diff --git a/docs/content/how-to/create-medusa-app.md b/docs/content/how-to/create-medusa-app.md deleted file mode 100644 index bd4a208aca..0000000000 --- a/docs/content/how-to/create-medusa-app.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -title: Using create-medusa-app ---- -# Using create-medusa-app -With the new `create-medusa-app` tool you will get your [Medusa](https://github.com/medusajs/medusa) development environment ready within a couple of minutes. After completion, you will have a Medusa backend, a Gatsby or Next.js storefront, and an admin dashboard up and running on your local machine. - -Starting a new e-commerce project just got easier, now with one command. - -## Getting started with `create-medusa-app` - -Use `create-medusa-app` with npx: - -```bash -npx create-medusa-app -``` - -Or Yarn: - -```bash -yarn create medusa-app -``` - -Behind the scenes, `create-medusa-app` is populating your database with some initial set of mock data, which helps to interact with Medusa setup intuitively straight away. - -Right after hitting one of those commands, the multistep installation process will be initiated, so the starter can be shaped right for the specific needs. - -### Destination folder - -Enter the path to the directory that will become the root of your Medusa project: - -```bash -? Where should your project be installed? › my-medusa-store -``` - -### Pick the starter you prefer - -```bash -? Which Medusa starter would you like to install? … -❯ medusa-starter-default - medusa-starter-contentful - Other -``` - -You will be presented with three options: - -- `medusa-starter-default` is the most lightweight version of a Medusa project -- `medusa-starter-contentful` almost like the default starter, but with `medusa-plugin-contentful` preinstalled -- `Other` if you have a different starter that you would wish to install from `Other` will give you the option of providing a URL to that starter. An additional question will be asked if you choose this option: - - ```bash - Where is the starter located? (URL or path) › https://github.com/somecoolusername/my-custom-medusa-starter - ``` - -For the walkthrough purposes, we assume that the selected starter is `medusa-starter-default` and proceed to the next step. - -### Selecting a Storefront - -After selecting your Medusa starter, you will be given the option to install one of our storefront starters. At the moment, we have starters for Gatsby and Next.js: - -```bash -Which storefront starter would you like to install? … -❯ Gatsby Starter - Next.js Starter - None -``` - -You may also select `None` if the choice is to craft a custom storefront for your product. - -`create-medusa-app` now has all of the info necessary for the installation to begin. - -```bash -Creating new project from git: https://github.com/medusajs/medusa-starter-default.git -✔ Created starter directory layout -Installing packages... -``` - -Once the installation has been completed, you will have a Medusa backend, a Demo storefront, and an Admin dashboard. - -## What's inside - -Inside the root folder which was specified at the beginning of the installation process the following structure could be found: - -```bash -/my-medusa-store - /storefront // Medusa storefront starter - /backend // Medusa starter as a backend option - /admin // Medusa admin panel -``` - -`create-medusa-app` prints out the commands that are available to you after installation. When each project is started, you can visit your storefront, complete the order, and view the order in Medusa admin. - -```bash -⠴ Installing packages... -✔ Packages installed -Initialising git in my-medusa-store/admin -Create initial git commit in my-medusa-store/admin - - Your project is ready 🚀. The available commands are: - - Medusa API - cd my-medusa-store/backend - yarn start - - Admin - cd my-medusa-store/admin - yarn start - - Storefront - cd my-medusa-store/storefront - yarn start -``` - -## **What's next?** - -To learn more about Medusa, go through our docs to get some inspiration and guidance for the next steps and further development: - -- [Find out how to set up a Medusa project with Gatsby and Contentful](https://docs.medusajs.com/how-to/headless-ecommerce-store-with-gatsby-contentful-medusa) -- [Move your Medusa setup to the next level with some custom functionality](https://docs.medusajs.com/tutorial/adding-custom-functionality) -- [Create your own Medusa plugin](../advanced/backend/payment/overview.md) - -If you have any follow-up questions or want to chat directly with our engineering team, we are always happy to meet you at our [Discord](https://discord.gg/DSHySyMu). diff --git a/docs/content/how-to/deploying-admin-on-netlify.md b/docs/content/how-to/deploying-admin-on-netlify.md deleted file mode 100644 index c956b08c65..0000000000 --- a/docs/content/how-to/deploying-admin-on-netlify.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: "Deploying Admin on Netlify" ---- - -# Deploying Admin on Netlify - -This is a guide for deploying Medusa Admin on Netlify. Netlify is a platform that offers hosting and backend services for applications and static websites. - -:::note - -At this point, you should have a running instance of Medusa Admin. If not, check out [these steps](https://github.com/medusajs/admin#-setting-up-admin) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. - -::: - -### 1. Install the Netlify CLI - -Install Netlify CLI on your machine using npm: - -```bash npm2yarn -npm install netlify-cli -g -``` - -### 2. Login to your Netlify account - -Connect to your Netlify account from your terminal: - -```bash -netlify login -``` - -Follow the instructions in your terminal. - -### 3. Netlify setup - -In order to deploy on Netlify, you need to create a new site, link the admin repository to the site and configure environment variables. - -The Netlify CLI is used to achieve this. - -#### Create a new site - -```bash -netlify init -``` - -Follow the instructions in your terminal to authorize and connect your Git repository. - -The default build and deploy settings fit the needs of a Gatsby application, so leave these as is. - -#### Add an environment variable - -```bash -netlify env:set GATSBY_MEDUSA_BACKEND_URL "https://your-medusa-server.com" -``` - -The above environment variable should point to your Medusa server. - -### 4. Push and deploy - -Finally to deploy the admin, commit and push your changes to the repository connected in step 3. - -```bash -git add . -git commit -m "Deploy Medusa Admin on Netlify" -git push origin main -``` - -Within a couple of minutes, your Medusa Admin is live and running on Netlify. - -:::tip - -If you experience CORS issues in your new setup, you might need to add your admin url as part of the ADMIN_CORS environment variable in your server setup. - -::: - -### What's next? - -If you haven't deployed your Medusa server to use with your new admin, check out our guide [Deploying on Heroku](https://docs.medusajs.com/how-to/deploying-on-heroku). diff --git a/docs/content/how-to/deploying-gatsby-on-netlify.md b/docs/content/how-to/deploying-gatsby-on-netlify.md deleted file mode 100644 index fbc8cbac86..0000000000 --- a/docs/content/how-to/deploying-gatsby-on-netlify.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: "Deploying your Gatsby storefront on Netlify" ---- - -# Deploying your Gatsby storefront on Netlify - -This is a guide for deploying our [Gatsby storefront starter](https://github.com/medusajs/gatsby-starter-medusa) on Netlify. Netlify is a platform that offers hosting and backend services for applications and static websites. The steps in this guide will work for most Gatsby projects. - -> At this point, you should have a local Gatsby storefront project running. If not, check out [our starter](https://github.com/medusajs/gatsby-starter-medusa) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. - -### 1. Install the Netlify CLI - -Install Netlify CLI on your machine using npm: - -```bash npm2yarn -npm install netlify-cli -g -``` - -### 2. Login to your Netlify account - -Connect to your Netlify account from your terminal: - -```bash -netlify login -``` - -Follow the instructions in your terminal. - -### 3. Netlify setup - -In order to deploy the project to Netlify, you need to create a new site, link the storefront Git repository to the site and configure environment variables. - -The Netlify CLI is used to achieve this. - -#### Create a new site - -```bash -netlify init -``` - -Follow the instructions in your terminal to authorize and connect your Git repository. - -The default build and deploy settings fit the needs of a Gatsby application, so leave these as is. - -#### Add an environment variable - -```bash -netlify env:set GATSBY_MEDUSA_BACKEND_URL "https://your-medusa-server.com" -``` - -The above environment variable should point to your Medusa server. - -### 4. Push and deploy - -Finally to deploy the storefront, commit and push your changes to the repository connected in step 3. - -```bash -git add . -git commit -m "Deploy Medusa Admin on Netlify" -git push origin main -``` - -Within a couple of minutes, your Gatsby storefront is up and running on Netlify. - -> If you experience CORS issues in your new setup, you might need to add your storefront url as part of the STORE_CORS environment variable in your server setup. - -### What's next? - -If you haven't deployed your Medusa server to use with your new storefront, check out our guide [Deploying on Heroku](https://docs.medusajs.com/how-to/deploying-on-heroku). - -Gatsby is not your thing? Check out our [Next.js storefront starter](https://github.com/medusajs/nextjs-starter-medusa). diff --git a/docs/content/how-to/deploying-on-heroku.md b/docs/content/how-to/deploying-on-heroku.md deleted file mode 100644 index 204032730d..0000000000 --- a/docs/content/how-to/deploying-on-heroku.md +++ /dev/null @@ -1,226 +0,0 @@ ---- -title: "Deploying on Heroku" ---- - -# Deploying on Heroku - -This is a guide for deploying a Medusa project on Heroku. Heroku is a PaaS (Platform as a Service) that allows you to easily deploy your applications in the cloud. - -
- -
- -:::note - -We assume, that you are currently running a local instance of Medusa. If not, check out our [Quickstart](https://docs.medusajs.com/quickstart/quick-start) or use `npx create-medusa-app` to set up your application in a matter of minutes. For the latter, see [this guide](https://docs.medusajs.com/how-to/create-medusa-app) for a small walkthrough. - -::: - -### 1. Install the Heroku CLI - -Install Heroku on your machine: - -**Ubuntu** - -```bash -sudo snap install --classic heroku -``` - -**MacOS** - -```bash -brew tap heroku/brew && brew install heroku -``` - -**Windows** - -Download the appropriate installer for your Windows installation: - -[64-bit installer](https://cli-assets.heroku.com/heroku-x64.exe) -[32-bit installer](https://cli-assets.heroku.com/heroku-x86.exe) - -### 2. Login to Heroku from your CLI - -Connect to your Heroku account from your terminal: - -```bash -heroku login -``` - -:::note - -Follow the instructions on your terminal - -::: - -### 3. Create an app on Heroku - -In your **Medusa project directory**, run the following commands to create an app on Heroku and add it as a remote origin. - -```bash -heroku create medusa-test-app -heroku git:remote -a medusa-test-app -``` - -### 4. Install Postgresql and Redis on Heroku - -Medusa requires a Postgres database and a Redis instance to work. These are added through the Heroku CLI using the following commands. - -:::tip - -In this example below, we initialize the resources on free plans. This is not a valid configuration for a production environment. - -::: - -#### Postgresql - -Add a Postgres add-on to your Heroku app - -```bash -heroku addons:create heroku-postgresql:hobby-dev -``` - -You can find more informations, plans and pricing about Heroku Postgres [here](https://elements.heroku.com/addons/heroku-postgresql). - -#### Redis To Go - -Add a Redis instance to your Heroku app - -:::note - -The add-on `redistogo:nano` is free, but Heroku requires you to add a payment method to proceed. - -::: - -```bash -heroku addons:create redistogo:nano -``` - -You can find more informations, plans and pricing about Redis To Go [here](https://elements.heroku.com/addons/redistogo). - -### 5. Configure environment variables on Heroku - -Medusa requires a set of environment variables. From you project repository, run the following commands:. - -```bash -heroku config:set NODE_ENV=production -heroku config:set JWT_SECRET=your-super-secret -heroku config:set COOKIE_SECRET=your-super-secret-pt2 -heroku config:set NPM_CONFIG_PRODUCTION=false -``` -:::tip - -Make sure to use actual secrets in a production environment. - -::: - -Additionally, we need to set the buildpack to Node.js - -```bash -heroku buildpacks:set heroku/nodejs -``` - -#### Configure the Redis URL - -The library we use for connecting to Redis, does not allow usernames in the connection string. Therefore, we need to perform the following commands to remove it. -Get the current Redis URL: - -```bash -heroku config:get REDISTOGO_URL -``` - -You should get something like: - -```bash -redis://redistogo:some_password_123@some.redistogo.com:9660/ -``` - -Remove the username from the Redis URL: - -```bash -redis://r̶e̶d̶i̶s̶t̶o̶g̶o̶:some_password_123@sole.redistogo.com:9660/ -``` - -Set the new environment variable `REDIS_URL` - -```bash -heroku config:set REDIS_URL=redis://:some_password_123@sole.redistogo.com:9660/ -``` - -### 6. Configure Medusa - -Before jumping into the deployment, we need to configure Medusa. - -#### `medusa-config.js` - -Update `module.exports` to include the following: - -```js -module.exports = { - projectConfig: { - redis_url: REDIS_URL, - database_url: DATABASE_URL, - database_type: "postgres", - store_cors: STORE_CORS, - admin_cors: ADMIN_CORS, - database_extra: - process.env.NODE_ENV !== "development" - ? { ssl: { rejectUnauthorized: false } } - : {}, - }, - plugins, -}; -``` - -#### `package.json` - -Update `scripts` to include the following: - -```json -... -"scripts": { - "serve": "medusa start", - "start": "medusa develop", - "heroku-postbuild": "medusa migrations run", - "prepare": "npm run build", - "build": "babel src -d dist --extensions \".ts,.js\"" -}, -... -``` - -### 6. Launch your Medusa app - -Finally, we need to commit and push our changes to Heroku: - -```bash -git add . -git commit -m "Deploy Medusa App on Heroku" -git push heroku HEAD:master -``` - -### 7. Inspect your build logs - -You can explore your Heroku app build logs using the following command in your project directory. - -```bash -heroku logs -n 500000 --remote heroku --tail -``` - -### 8. Create a user (optional) - -As an optional extra step, we can create a user for you to use when your admin system is up and running. - -```bash -heroku run -a medusa-test-app -- medusa user -e "some-user@test.com" -p "SuperSecret1234" -``` - -### What's next? - -You now have a production ready application running on Heroku. This can be scaled and configured to fit your business needs. - -Furthermore, you can deploy a Medusa Admin for your application, such that you can start managing your store from an interface. - -- [Deploy Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) -- Deploy Admin on Gatsby Cloud (Coming soon) diff --git a/docs/content/how-to/making-your-store-more-powerful-with-contentful.md b/docs/content/how-to/making-your-store-more-powerful-with-contentful.md index afb3a9a346..8119729bdf 100644 --- a/docs/content/how-to/making-your-store-more-powerful-with-contentful.md +++ b/docs/content/how-to/making-your-store-more-powerful-with-contentful.md @@ -312,5 +312,5 @@ In this guide you created a new content model for Rich Text input in Contentful 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 on Heroku](https://docs.medusajs.com/how-to/deploying-on-heroku) -- [Deploying Medusa Admin on Netlify](https://docs.medusajs.com/how-to/deploying-admin-on-netlify) +- [Deploying Medusa Server](../deployments/server/index.mdx) +- [Deploying Medusa Admin](../deployments/admin/index.mdx) diff --git a/docs/content/quickstart/quick-start.md b/docs/content/quickstart/quick-start.md index 378b5e1cdc..d871aa6cd4 100644 --- a/docs/content/quickstart/quick-start.md +++ b/docs/content/quickstart/quick-start.md @@ -75,7 +75,7 @@ You can learn more about configuring your server and loading environment variabl ## What's next :rocket: -- Install our [Next.js](http://localhost:3000/starters/nextjs-medusa-starter) or [Gatsby](http://localhost:3000/starters/gatsby-medusa-starter) storefronts to set up your ecommerce storefront quickly. +- Install our [Next.js](../starters/nextjs-medusa-starter) or [Gatsby](../starters/gatsby-medusa-starter) storefronts to set up your ecommerce storefront quickly. - Install the [Medusa Admin](../admin/quickstart.md) to supercharge your ecommerce experience with easy access to configurations and features. - Check our the [API reference](https://docs.medusajs.com/api) to learn more about available endpoints available on your Medusa server. - Install [plugins](https://github.com/medusajs/medusa/tree/master/packages) for features like Payment, CMS, Notifications, among other features. diff --git a/docs/content/starters/gatsby-medusa-starter.md b/docs/content/starters/gatsby-medusa-starter.md index aa6b6f67fa..794cda621c 100644 --- a/docs/content/starters/gatsby-medusa-starter.md +++ b/docs/content/starters/gatsby-medusa-starter.md @@ -14,6 +14,12 @@ You should also have the Gatsby CLI installed: npm install gatsby-cli -g ``` + + ## Installation 1\. Create a new Gatsby project using the [Medusa starter template](https://github.com/medusajs/gatsby-starter-medusa): @@ -103,5 +109,5 @@ The Gatsby storefront comes with a lot of features out of the box including: ## What’s Next 🚀 - Check the [Storefront API reference](https://docs.medusajs.com/api/store/auth) for a full list of REST APIs to use on your storefront. -- Learn how to [deploy the Gatsby storefront on Netlify](../how-to/deploying-gatsby-on-netlify.md). +- Learn how to [deploy the Gatsby storefront on Netlify](../deployments/storefront/deploying-gatsby-on-netlify.md). - Learn how to add [Stripe as a payment provider](../add-plugins/stripe.md#gatsby-storefront). diff --git a/docs/content/troubleshooting/cors-issues.md b/docs/content/troubleshooting/cors-issues.md index e1611aa11d..6cad1e6b18 100644 --- a/docs/content/troubleshooting/cors-issues.md +++ b/docs/content/troubleshooting/cors-issues.md @@ -1,21 +1,25 @@ # CORS issues -If you are experiencing connection issues when trying to access your Medusa instance from a storefront, it is most likely due to CORS issues. +If you are experiencing connection issues when trying to access your Medusa server from a storefront, it is most likely due to CORS issues. You might see a log in your browser console, that looks like this: ![CORS error log](https://i.imgur.com/jnHK115.png) -In your `medusa-config.js` , you should ensure that you've configured your CORS settings correctly. By default, the Medusa starter run on port 9000, Medusa Admin on port 7000, and the storefront starters on port 8000. +In your `medusa-config.js` , you should ensure that you've configured your CORS settings correctly. By default, the Medusa starter runs on port `9000`, Medusa Admin runs on port `7000`, and the storefront starters run on port `8000`. The default configuration uses the following CORS settings: ```jsx // CORS when consuming Medusa from admin -const ADMIN_CORS = process.env.ADMIN_CORS || "http://localhost:7000" +const ADMIN_CORS = process.env.ADMIN_CORS || "http://localhost:7000,http://localhost:7001" // CORS to avoid issues when consuming Medusa from a client const STORE_CORS = process.env.STORE_CORS || "http://localhost:8000" ``` -If you wish to run your storefront or Medusa admin on other ports, you should update the above settings accordinly. +If you wish to run your storefront or Medusa admin on other ports, you should update the above settings accordingly. + +## Additional Resources + +To learn more about CORS configurations, check out the [Configure your Server](../usage/configurations.md) documentation. diff --git a/docs/content/troubleshooting/documentation-error.md b/docs/content/troubleshooting/documentation-error.md index 4769bbfad0..d16945be1d 100644 --- a/docs/content/troubleshooting/documentation-error.md +++ b/docs/content/troubleshooting/documentation-error.md @@ -1,7 +1,7 @@ # Documentation Error -If you have installed the dependencies in the root of this repository (i.e., if you have a `node_modules` directory at the root of this repository), this will cause an error when running this documentation website. This is because the content resides in `docs/content` and when that content is being imported from there, a mix up can happen between the dependencies which will cause an `invalid hook call` error. +If you have installed the dependencies in the root of the Medusa repository (i.e., if you have a `node_modules` directory at the root of the Medusa repository), this will cause an error when running the documentation website. -For that reason, we added a `clean-node-modules` script that deletes the `node_modules` directory, and we call that script before the `start` and `build` scripts are ran. +This is because the content resides in `docs/content`. When that content is being imported from there, a mix up can happen between the dependencies in the root of the Medusa repository and the dependencies in `www/docs` which causes an `invalid hook call` error. -So, everytime you run these 2 scripts, the `node_modules` directory at the root will be deleted. +For that reason, when the `start` and `build` scripts in `www/docs` are used, the `clean-node-modules` script is called. This script deleted the `node_modules` directory in the root of the Medusa repository. diff --git a/docs/content/troubleshooting/missing-payment-providers.md b/docs/content/troubleshooting/missing-payment-providers.md index e0ab0ae5c8..edca037a70 100644 --- a/docs/content/troubleshooting/missing-payment-providers.md +++ b/docs/content/troubleshooting/missing-payment-providers.md @@ -1,4 +1,4 @@ -# Stripe not showing in checkout +# Payment Provider (Stripe) not showing in checkout You add payment providers to your Medusa instance by adding them as plugins in `medusa-config.js`: @@ -17,14 +17,19 @@ const plugins = [ ]; ``` -And installing them through your favourite package manager: +And installing them with your favourite package manager: ```bash npm2yarn npm install medusa-payment-stripe ``` -Though, to be able to also show them as part of your checkout flow, you need to add them to your regions. +However, to also show them as part of your checkout flow you need to add them to your regions. -In Medusa Admin go to Settings -> Regions and select your newly added payment provider: +In the Medusa Admin go to Settings > Regions and for each region scroll down to the Payment Provider input and choose the payment provider you want to use in that region: -![](https://i.imgur.com/CfR9BCV.png) +![Enable Payment Provider](https://i.imgur.com/FH5vgWh.png) + +## Additional Resources + +- Learn how to install [Stripe](../add-plugins/stripe.md) as a payment provider. +- Learn more about the [Payment architecture](../advanced/backend/payment/overview.md). diff --git a/docs/content/troubleshooting/redis-events.md b/docs/content/troubleshooting/redis-events.md index d47d566f7f..c730cf6761 100644 --- a/docs/content/troubleshooting/redis-events.md +++ b/docs/content/troubleshooting/redis-events.md @@ -1,25 +1,29 @@ # Redis not emitting events -When you create a new Medusa project, Redis is disabled by default. Instead, we use a fake Redis server, that allows you to start your project, but holds no functionality. +When you create a new Medusa server, Redis is disabled by default. Instead, a fake Redis server is used that allows you to start your project but does not actually emit any events. -To enable a real Redis server, you need to install and start it up on your PC. Install it directly from their [website](https://redis.io/download) or use Homebrew and run the following commands: +To enable a real Redis server, you need to install Redis on your machine and configure it with Medusa. -```bash -brew install redis -brew services start redis -``` +You can learn how to [install Redis in the Set Up your Development Environment documentation](../tutorial/0-set-up-your-development-environment.mdx#redis). -Additonally, ensure that `redis_url` is not commented out in your project configuration in the bottom of your `medusa-config.js`. +After installing it, make sure to configure your Medusa server to use Redis: ```jsx module.exports = { projectConfig: { - redis_url: REDIS_URL, // <-- Enables a real Redis server - database_url: DATABASE_URL, - database_type: "postgres", - store_cors: STORE_CORS, - admin_cors: ADMIN_CORS, + //... + redis_url: REDIS_URL, }, - plugins, } ``` + +By default, Medusa connects to Redis over the URL `redis://localhost:6379`. If you need to change that URL, set the following environment variable: + +```bash +REDIS_URL= +``` + +## Additional Resources + +- Learn how to [set up your development environment](../tutorial/0-set-up-your-development-environment.mdx). +- Learn how to [configure your server](../usage/configurations.md). diff --git a/docs/content/troubleshooting/signing-in-to-admin.md b/docs/content/troubleshooting/signing-in-to-admin.md index 6df2d6ec13..4896aa7225 100644 --- a/docs/content/troubleshooting/signing-in-to-admin.md +++ b/docs/content/troubleshooting/signing-in-to-admin.md @@ -1,13 +1,18 @@ # Signing in to Medusa Admin -If you've created a new Medusa project and seeded the database using our predefined script, the default credentials are: +If you've created a new Medusa server with the `--seed` option or used the `seed` script or command, the default credentials are: ```bash -admin@medusa-test.com // supersecret +email: admin@medusa-test.com +password: supersecret ``` -Though, you can create your own users using our CLI: +Alternatively, you can create your own users using the Medusa CLI tool: -``` +```bash medusa user -e some@email.com -p somepassword ``` + +## Additional Resources + +Learn more about our CLI tool in the [CLI reference](../cli/reference.md). diff --git a/docs/content/troubleshooting/transaction-error-in-checkout.md b/docs/content/troubleshooting/transaction-error-in-checkout.md index 42a2e7e7b8..9b096505d8 100644 --- a/docs/content/troubleshooting/transaction-error-in-checkout.md +++ b/docs/content/troubleshooting/transaction-error-in-checkout.md @@ -1,45 +1,59 @@ # Error 409 in checkout -To provide the most frictionless onboarding and quick start, we default to SQLite as database. SQLite runs on all PCs, which is why it allows you to get quickly started without installing Postgres. Though, it comes at the expense of important features, that are needed in a production environment. +To provide the most frictionless onboarding and quickstart, Medusa uses SQLite as the server's database by default. SQLite runs on all machines and operating systems. So, it allows you to get quickly started without installing PostgreSQL. -Therefore, you might experience the following error when going through a checkout flow in our starters: +However, this comes at the expense of important features that are needed in a production environment. -``` +Therefore, you might experience the following error when going through a checkout flow in one of Medusa's starters while using SQLite: + +```bash Error: Transaction already started for the given connection, commit current transaction before starting a new one. ``` -This error occurs because SQLite does not allow for multiple write transactions at the same time. To resolve it, you need to use Postgres instead. +This error occurs because SQLite does not allow for multiple write transactions at the same time. To resolve it, you need to use PostgreSQL instead. -First install and start Postgres on your local machine. You can either [download it directly from their website](https://www.postgresql.org/download/) or use Homebrew: +You can learn how to install PostgreSQL on your machine in the [Set Up your Development Environment documentation](../tutorial/0-set-up-your-development-environment.mdx#postgresql). -```bash -brew install postgresql -brew services start postgresql -createdb -``` - -Then in your `medusa-config.js`, you should change the project config to use Postgres as database type: +Then in your `medusa-config.js`, you should change the project configuration to use Postgres as the database type: ```jsx module.exports = { projectConfig: { - redis_url: REDIS_URL, - // The following two lines will enable Postgres + //... database_url: DATABASE_URL, database_type: "postgres", - store_cors: STORE_CORS, - admin_cors: ADMIN_CORS, }, plugins, } ``` +Where `DATABASE_URL` is the connection string to your PostgreSQL database. You can check out how to format it in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html). + +Make sure to also remove the following lines that are used to configure an SQLite database: + +```jsx +database_type: "sqlite", +database_database: "./medusa-db.sql", +``` + +Then, migrate the database schema to the new PostgreSQL database: + +```bash +medusa migrations run +``` + :::tip -When changing from SQLite to Postgres, you should seed the database again using: +If you want to add demo data into your server, you should also seed the database using the following command: ```bash npm2yarn npm run seed ``` ::: + +## Additional Resources + +- Learn how to [set up your development environment](../tutorial/0-set-up-your-development-environment.mdx). +- Learn how to [configure your server](../usage/configurations.md). +- Learn more about [the Medusa CLI tool](../cli/reference.md). diff --git a/docs/content/usage/configurations.md b/docs/content/usage/configurations.md index b51027d614..2aabee21f7 100644 --- a/docs/content/usage/configurations.md +++ b/docs/content/usage/configurations.md @@ -111,6 +111,14 @@ module.exports = { Where `database_type` is `postgres` and `DATABASE_URL` is the URL connection string to your PostgreSQL database. You can check out how to format it in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html). +It is recommended to set the Database URL as an environment variable: + +```bash +DATABASE_URL= +``` + +Where `` is the URL of your PostgreSQL database. + ### Common Configuration As Medusa internally uses [Typeorm](https://typeorm.io/) to connect to the database, the following configurations are also available: @@ -145,13 +153,21 @@ module.exports = { Where `REDIS_URL` is the URL used to connect to Redis. The format of the connection string is `redis[s]://[[username][:password]@][host][:port][/db-number]`. +If you omit this configuration, events will not be emitted and subscribers will not work. + :::tip By default, the Redis connection string should be `redis://localhost:6379` unless you made any changes to the default configurations during the installation. ::: -If you omit this configuration, events will not be emitted and subscribers will not work. +It is recommended to set the Redis URL as an environment variable: + +```bash +REDIS_URL= +``` + +Where `` is the URL of your Redis server. :::info @@ -174,6 +190,14 @@ module.exports = { Where `jwt_secret` is the secret used to create the tokens. The more secure it is the better. +It is recommended to set the JWT Secret as an environment variable: + +```bash +JWT_SECRET= +``` + +Where `` is the JWT secret you want to use. + :::caution In a development environment, if this option is not set the default secret is “supersecret”. However, in production, if this option is not set an error will be thrown and your server will crash. @@ -195,6 +219,14 @@ module.exports = { Where `cookie_secret` is the secret used to create the tokens. The more secure it is the better. +It is recommended to set the Cookie secret as an environment variable: + +```bash +COOKIE_SECRET= +``` + +Where `` is the Cookie secret you want to use. + :::caution In a development environment, if this option is not set the default secret is “supersecret”. However, in production, if this option is not set an error will be thrown and your server will crash. @@ -216,6 +248,14 @@ module.exports = { Where `ADMIN_CORS` is the URL of your admin dashboard. By default, it’s `http://localhost:7000,http://localhost:7001`. +It is recommended to set the Admin CORS as an environment variable: + +```bash +ADMIN_CORS= +``` + +Where `` is the URL of your admin dashboard. + ## Storefront CORS Medusa uses CORS to only allow specific origins to access the server. To make sure your Storefront dashboard can access the Medusa server, set this configuration: @@ -231,6 +271,14 @@ module.exports = { Where `STORE_CORS` is the URL of your storefront. By default, it’s `http://localhost:8000`. +It is recommended to set the Storefront CORS as an environment variable: + +```bash +STORE_CORS= +``` + +Where `` is the URL of your storefront. + ## Plugins On your Medusa server, you can use Plugins to add custom features or integrate third-party services. For example, installing a plugin to use Stripe as a payment provider. @@ -279,8 +327,14 @@ const plugins = [ ]; ``` +:::tip + +It is recommended to use environment variables to store values of options instead of hardcoding them in `medusa-config.js`. + +::: + ## What’s Next 🚀 - Check out our [Next.js](../starters/nextjs-medusa-starter.md) and [Gatsby](../starters/gatsby-medusa-starter.md) starter storefronts. - Install the [Medusa admin](../admin/quickstart.md). -- Learn about [deploying the Medusa server on Heroku](../how-to/deploying-on-heroku.md). +- Learn about [deploying the Medusa server](../deployments/server/index.mdx). diff --git a/docs/content/usage/create-medusa-app.mdx b/docs/content/usage/create-medusa-app.mdx new file mode 100644 index 0000000000..4956eb7122 --- /dev/null +++ b/docs/content/usage/create-medusa-app.mdx @@ -0,0 +1,121 @@ +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Use create-medusa-app + +In this document, you’ll learn how to use `create-medusa-app` to create a Medusa project with the 3 main components of Medusa. + +## Overview + +As explained in the [Introduction guide](../introduction.md), Medusa is composed of 3 different components: the headless server, the storefront, and the admin dashboard. + +Medusa provides the necessary tools and resources to set up the 3 components separately. This ensures that developers have full freedom to choose their tech stack, as they can choose any framework for the storefront and admin dashboard. + +However, if you’re interested in using Medusa’s starters for the 3 components, you can easily make use of the `create-medusa-app` command instead of creating each separately. + +When you run the `create-medusa-app` command, you’ll install a Medusa server, a Medusa admin, and optionally a storefront at the same time. + +## How to Create a Medusa Project + +In your terminal, run the following command: + + + + + ```bash + npx create-medusa-app + ``` + + + + + ```bash + yarn create medusa-app + ``` + + + + +### Project Directory Name + +You’ll then be asked to enter the name of the directory you want the project to be installed in. You can either leave the default value `my-medusa-store` or enter a new name. + +### Choose Medusa Starter + +Next, you’ll be asked to choose the Medusa starter used to install the Medusa server. You can either pick the default Medusa starter, the Contentful starter or enter a starter URL by choosing `Other`: + +```bash +? Which Medusa starter would you like to install? … +❯ medusa-starter-default + medusa-starter-contentful + Other +``` + +The server will be installed under the `backend` directory under the project directory. An SQLite database will be created inside that directory as well with demo data seeded into it. + +:::tip + +You can learn more about the Contentful starter in the [Contentful Integration documentation](../add-plugins/contentful.md). + +::: + +### Choose Storefront Starter + +After choosing the Medusa starter, you’ll be asked to choose the storefront starter. You can choose one of the starters in the list included or choose `None` to skip installing a storefront: + +```bash +? Which storefront starter would you like to install? +❯ Gatsby Starter +Next.js Starter +medusa.express (Next.js) +medusa.express (Gatsby) +Gatsby Starter (Simple) +None +``` + +If you choose an option other than `None`, a storefront will be installed under the `storefront` directory. + +:::tip + +Learn more about the [Next.js](../starters/nextjs-medusa-starter.md) and [Gatsby](../starters/gatsby-medusa-starter.md) starter storefronts. + +::: + +### Dependency Installation + +After choosing the above starters, the installation of each component will begin along with its dependencies. Once the installation is done, you’ll see instructions related to how to start each component. + +```bash +Your project is ready 🚀. The available commands are: + +Medusa API +cd my-medusa-store/backend +yarn start + +Admin +cd my-medusa-store/admin +yarn start + +Storefront +cd my-medusa-store/storefront +yarn start +``` + +The commands will differ based on your choices in previous prompts. + +## Project Directory Structure + +Inside the root project directory which was specified at the beginning of the installation process you’ll find the following directory structure: + +```bash +/my-medusa-store + /storefront // Medusa storefront starter + /backend // Medusa starter as a backend option + /admin // Medusa admin panel +``` + +## What’s Next 🚀 + +- Learn how to [deploy the Medusa server](../deployments/server/index.mdx). +- Learn how to [deploy the Medusa admin](../deployments/admin/index.mdx). +- Learn how to [deploy the storefront](../deployments/storefront/index.mdx). \ No newline at end of file diff --git a/packages/medusa-cli/CHANGELOG.md b/packages/medusa-cli/CHANGELOG.md index 22bd3d385e..1003cf2fee 100644 --- a/packages/medusa-cli/CHANGELOG.md +++ b/packages/medusa-cli/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.3.1](https://github.com/medusajs/medusa/compare/@medusajs/medusa-cli@1.3.0...@medusajs/medusa-cli@1.3.1) (2022-07-05) + + +### Features + +* **medusa-cli:** Allow to revert migrations from the CLI ([#1353](https://github.com/medusajs/medusa/issues/1353)) ([012513b](https://github.com/medusajs/medusa/commit/012513b6a1e90169e9e0e53f7a59841a34fbaeb3)) + + + + + # [1.3.0](https://github.com/medusajs/medusa/compare/@medusajs/medusa-cli@1.2.1...@medusajs/medusa-cli@1.3.0) (2022-05-01) **Note:** Version bump only for package @medusajs/medusa-cli diff --git a/packages/medusa-cli/package.json b/packages/medusa-cli/package.json index c46968a0ca..613a89c7b0 100644 --- a/packages/medusa-cli/package.json +++ b/packages/medusa-cli/package.json @@ -1,6 +1,6 @@ { "name": "@medusajs/medusa-cli", - "version": "1.3.0", + "version": "1.3.1", "description": "Command Line interface for Medusa Commerce", "main": "dist/index.js", "bin": { diff --git a/packages/medusa-dev-cli/CHANGELOG.md b/packages/medusa-dev-cli/CHANGELOG.md index 0fc365bdd8..20a23dd239 100644 --- a/packages/medusa-dev-cli/CHANGELOG.md +++ b/packages/medusa-dev-cli/CHANGELOG.md @@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [0.0.26](https://github.com/medusajs/medusa/compare/medusa-dev-cli@0.0.24...medusa-dev-cli@0.0.26) (2022-07-05) + +**Note:** Version bump only for package medusa-dev-cli + + + + + +## [0.0.25](https://github.com/medusajs/medusa/compare/medusa-dev-cli@0.0.24...medusa-dev-cli@0.0.25) (2022-07-05) + +**Note:** Version bump only for package medusa-dev-cli + + + + + ## [0.0.24](https://github.com/medusajs/medusa/compare/medusa-dev-cli@0.0.23...medusa-dev-cli@0.0.24) (2021-12-08) **Note:** Version bump only for package medusa-dev-cli diff --git a/packages/medusa-dev-cli/package.json b/packages/medusa-dev-cli/package.json index 193539da50..870e0b05a0 100644 --- a/packages/medusa-dev-cli/package.json +++ b/packages/medusa-dev-cli/package.json @@ -1,7 +1,7 @@ { "name": "medusa-dev-cli", "description": "CLI helpers for contributors working on Medusa", - "version": "0.0.24", + "version": "0.0.26", "author": "Sebastian Rindom ", "bin": { "medusa-dev": "./dist/index.js" @@ -14,7 +14,7 @@ "execa": "^4.1.0", "find-yarn-workspace-root": "^2.0.0", "fs-extra": "^9.0.1", - "got": "^10.7.0", + "got": "^11.8.5", "is-absolute": "^1.0.0", "jest": "^25.5.2", "lodash": "^4.17.21", diff --git a/packages/medusa-file-minio/CHANGELOG.md b/packages/medusa-file-minio/CHANGELOG.md index bdd957fc6e..0122cad5ee 100644 --- a/packages/medusa-file-minio/CHANGELOG.md +++ b/packages/medusa-file-minio/CHANGELOG.md @@ -3,6 +3,23 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.0.7](https://github.com/medusajs/medusa/compare/medusa-file-minio@1.0.6...medusa-file-minio@1.0.7) (2022-07-05) + + +### Bug Fixes + +* **medusa-file-spaces,medusa-file-s3,medusa-file-minio:** Add options to super call in file plugins ([#1714](https://github.com/medusajs/medusa/issues/1714)) ([a5f717b](https://github.com/medusajs/medusa/commit/a5f717be5ae1954f3dbf1e7b2edb35d11088a8c8)) + + +### Features + +* **medusa:** Delete and download url endpoints ([#1705](https://github.com/medusajs/medusa/issues/1705)) ([cc29b64](https://github.com/medusajs/medusa/commit/cc29b641c9358415b46179371988e7ddc11d2664)) +* **medusa:** Extend file-service interface + move to core ([#1577](https://github.com/medusajs/medusa/issues/1577)) ([8e42d37](https://github.com/medusajs/medusa/commit/8e42d37e84e80c003b9c0311117ab8a8871aa61b)) + + + + + ## [1.0.6](https://github.com/medusajs/medusa/compare/medusa-file-minio@1.0.4...medusa-file-minio@1.0.6) (2022-06-19) **Note:** Version bump only for package medusa-file-minio diff --git a/packages/medusa-file-minio/package.json b/packages/medusa-file-minio/package.json index f4eed1c34b..61f00614ef 100644 --- a/packages/medusa-file-minio/package.json +++ b/packages/medusa-file-minio/package.json @@ -1,6 +1,6 @@ { "name": "medusa-file-minio", - "version": "1.0.6", + "version": "1.0.7", "description": "MinIO server file connector for Medusa", "main": "index.js", "repository": { @@ -42,5 +42,9 @@ "medusa-core-utils": "^1.1.31", "medusa-test-utils": "^1.1.37" }, - "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011" + "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011", + "keywords": [ + "medusa-plugin", + "medusa-plugin-file" + ] } diff --git a/packages/medusa-file-s3/CHANGELOG.md b/packages/medusa-file-s3/CHANGELOG.md index 9c13299bc0..0f2c566677 100644 --- a/packages/medusa-file-s3/CHANGELOG.md +++ b/packages/medusa-file-s3/CHANGELOG.md @@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.1.3](https://github.com/medusajs/medusa/compare/medusa-file-s3@1.1.2...medusa-file-s3@1.1.3) (2022-07-05) + + +### Bug Fixes + +* **medusa-file-spaces,medusa-file-s3,medusa-file-minio:** Add options to super call in file plugins ([#1714](https://github.com/medusajs/medusa/issues/1714)) ([a5f717b](https://github.com/medusajs/medusa/commit/a5f717be5ae1954f3dbf1e7b2edb35d11088a8c8)) + + +### Features + +* **medusa:** Extend file-service interface + move to core ([#1577](https://github.com/medusajs/medusa/issues/1577)) ([8e42d37](https://github.com/medusajs/medusa/commit/8e42d37e84e80c003b9c0311117ab8a8871aa61b)) + + + + + ## [1.1.2](https://github.com/medusajs/medusa/compare/medusa-file-s3@1.1.0...medusa-file-s3@1.1.2) (2022-06-19) **Note:** Version bump only for package medusa-file-s3 diff --git a/packages/medusa-file-s3/package.json b/packages/medusa-file-s3/package.json index 661c479e8b..e01efa029b 100644 --- a/packages/medusa-file-s3/package.json +++ b/packages/medusa-file-s3/package.json @@ -1,6 +1,6 @@ { "name": "medusa-file-s3", - "version": "1.1.2", + "version": "1.1.3", "description": "AWS s3 file connector for Medusa", "main": "index.js", "repository": { @@ -43,5 +43,9 @@ "medusa-core-utils": "^1.1.31", "medusa-test-utils": "^1.1.37" }, - "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808" + "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808", + "keywords": [ + "medusa-plugin", + "medusa-plugin-file" + ] } diff --git a/packages/medusa-file-spaces/CHANGELOG.md b/packages/medusa-file-spaces/CHANGELOG.md index ddb744b9bc..76d4f29ded 100644 --- a/packages/medusa-file-spaces/CHANGELOG.md +++ b/packages/medusa-file-spaces/CHANGELOG.md @@ -3,6 +3,24 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.2.3](https://github.com/medusajs/medusa/compare/medusa-file-spaces@1.2.2...medusa-file-spaces@1.2.3) (2022-07-05) + + +### Bug Fixes + +* **medusa-file-spaces,medusa-file-s3,medusa-file-minio:** Add options to super call in file plugins ([#1714](https://github.com/medusajs/medusa/issues/1714)) ([a5f717b](https://github.com/medusajs/medusa/commit/a5f717be5ae1954f3dbf1e7b2edb35d11088a8c8)) + + +### Features + +* **medusa:** Add batch strategy for order exports ([#1603](https://github.com/medusajs/medusa/issues/1603)) ([bf47d1a](https://github.com/medusajs/medusa/commit/bf47d1aecd74f4489667609444a8b09393e894d3)) +* **medusa:** Extend file-service interface + move to core ([#1577](https://github.com/medusajs/medusa/issues/1577)) ([8e42d37](https://github.com/medusajs/medusa/commit/8e42d37e84e80c003b9c0311117ab8a8871aa61b)) +* **medusa-file-spaces:** DigitalOcean fileservice streaming ([#1585](https://github.com/medusajs/medusa/issues/1585)) ([abaf10b](https://github.com/medusajs/medusa/commit/abaf10b31d1e9a60710da87cac5c9c869195660d)), closes [#1583](https://github.com/medusajs/medusa/issues/1583) [#1580](https://github.com/medusajs/medusa/issues/1580) [#1582](https://github.com/medusajs/medusa/issues/1582) [#1583](https://github.com/medusajs/medusa/issues/1583) [#1580](https://github.com/medusajs/medusa/issues/1580) [#1582](https://github.com/medusajs/medusa/issues/1582) + + + + + ## [1.2.2](https://github.com/medusajs/medusa/compare/medusa-file-spaces@1.2.0...medusa-file-spaces@1.2.2) (2022-06-19) diff --git a/packages/medusa-file-spaces/package.json b/packages/medusa-file-spaces/package.json index b1b4f41b09..4a420eaca5 100644 --- a/packages/medusa-file-spaces/package.json +++ b/packages/medusa-file-spaces/package.json @@ -1,6 +1,6 @@ { "name": "medusa-file-spaces", - "version": "1.2.2", + "version": "1.2.3", "description": "Digital Ocean Spaces file connector for Medusa", "main": "index.js", "repository": { @@ -44,5 +44,9 @@ "medusa-test-utils": "^1.1.37", "stripe": "^8.50.0" }, - "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808" + "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808", + "keywords": [ + "medusa-plugin", + "medusa-plugin-file" + ] } diff --git a/packages/medusa-fulfillment-manual/package.json b/packages/medusa-fulfillment-manual/package.json index 437877e5aa..5e1d30e6a9 100644 --- a/packages/medusa-fulfillment-manual/package.json +++ b/packages/medusa-fulfillment-manual/package.json @@ -38,5 +38,9 @@ "express": "^4.17.1", "medusa-core-utils": "^1.1.31" }, - "gitHead": "7770046479c361f375842a8605b15e5d7bc24624" + "gitHead": "7770046479c361f375842a8605b15e5d7bc24624", + "keywords": [ + "medusa-plugin", + "medusa-plugin-fulfillment" + ] } diff --git a/packages/medusa-fulfillment-webshipper/CHANGELOG.md b/packages/medusa-fulfillment-webshipper/CHANGELOG.md index 176dfdcbdc..c4b64c2f13 100644 --- a/packages/medusa-fulfillment-webshipper/CHANGELOG.md +++ b/packages/medusa-fulfillment-webshipper/CHANGELOG.md @@ -3,6 +3,18 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.3.3](https://github.com/medusajs/medusa/compare/medusa-fulfillment-webshipper@1.3.2...medusa-fulfillment-webshipper@1.3.3) (2022-07-05) + + +### Bug Fixes + +* **webshipper:** allow cancelling WS orders with error status ([#1755](https://github.com/medusajs/medusa/issues/1755)) ([1d3032d](https://github.com/medusajs/medusa/commit/1d3032dc671b477654afd13a218caa772454bde0)) +* **webshipper:** only add invoices if invoice generator produces a file ([#1749](https://github.com/medusajs/medusa/issues/1749)) ([c0e18d4](https://github.com/medusajs/medusa/commit/c0e18d473c050d143f67ed2c76fa9ec9414daf1a)) + + + + + ## [1.3.2](https://github.com/medusajs/medusa/compare/medusa-fulfillment-webshipper@1.3.0...medusa-fulfillment-webshipper@1.3.2) (2022-06-19) **Note:** Version bump only for package medusa-fulfillment-webshipper diff --git a/packages/medusa-fulfillment-webshipper/package.json b/packages/medusa-fulfillment-webshipper/package.json index 2828845915..c573f00cf1 100644 --- a/packages/medusa-fulfillment-webshipper/package.json +++ b/packages/medusa-fulfillment-webshipper/package.json @@ -1,6 +1,6 @@ { "name": "medusa-fulfillment-webshipper", - "version": "1.3.2", + "version": "1.3.3", "description": "Webshipper Fulfillment provider for Medusa", "main": "index.js", "repository": { @@ -18,7 +18,7 @@ "@babel/plugin-transform-runtime": "^7.7.6", "@babel/preset-env": "^7.7.5", "@babel/runtime": "^7.9.6", - "@medusajs/medusa": "^1.3.2", + "@medusajs/medusa": "^1.3.3", "client-sessions": "^0.8.0", "cross-env": "^5.2.1", "eslint": "^6.8.0", @@ -40,5 +40,9 @@ "express": "^4.17.1", "medusa-core-utils": "^1.1.31" }, - "gitHead": "7770046479c361f375842a8605b15e5d7bc24624" + "gitHead": "7770046479c361f375842a8605b15e5d7bc24624", + "keywords": [ + "medusa-plugin", + "medusa-plugin-fulfillment" + ] } diff --git a/packages/medusa-interfaces/CHANGELOG.md b/packages/medusa-interfaces/CHANGELOG.md index 1e113123ed..c0adee0198 100644 --- a/packages/medusa-interfaces/CHANGELOG.md +++ b/packages/medusa-interfaces/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.3.1](https://github.com/medusajs/medusa/compare/medusa-interfaces@1.3.0...medusa-interfaces@1.3.1) (2022-07-05) + + +### Bug Fixes + +* **medusa:** Remove deps `mongoose` + `mongodb` ([#1218](https://github.com/medusajs/medusa/issues/1218)) ([c76e23e](https://github.com/medusajs/medusa/commit/c76e23e84dd8cb08c3c709f9f95c4c17b9685439)) + + + + + # [1.3.0](https://github.com/medusajs/medusa/compare/medusa-interfaces@1.2.1...medusa-interfaces@1.3.0) (2022-05-01) diff --git a/packages/medusa-interfaces/package.json b/packages/medusa-interfaces/package.json index c262ba0f46..1814d84ea8 100644 --- a/packages/medusa-interfaces/package.json +++ b/packages/medusa-interfaces/package.json @@ -1,6 +1,6 @@ { "name": "medusa-interfaces", - "version": "1.3.0", + "version": "1.3.1", "description": "Core interfaces for Medusa", "main": "dist/index.js", "repository": { diff --git a/packages/medusa-js/CHANGELOG.md b/packages/medusa-js/CHANGELOG.md index 6d960a61f0..5470677f08 100644 --- a/packages/medusa-js/CHANGELOG.md +++ b/packages/medusa-js/CHANGELOG.md @@ -3,6 +3,23 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.2.3](https://github.com/medusajs/medusa/compare/@medusajs/medusa-js@1.2.2...@medusajs/medusa-js@1.2.3) (2022-07-05) + + +### Bug Fixes + +* **medusa-js:** Fix `stringifyNullProperties` util ([#1766](https://github.com/medusajs/medusa/issues/1766)) ([7bee57f](https://github.com/medusajs/medusa/commit/7bee57f7c55e15b6a6c847dfda433e67f258ef8e)) + + +### Features + +* **medusa-js:** Create utils to stringify null values and respect object types ([#1748](https://github.com/medusajs/medusa/issues/1748)) ([fc1cbe7](https://github.com/medusajs/medusa/commit/fc1cbe72c7b0cd2879a8b112a6f63fa94c728a19)) +* **medusa,medusa-js,medusa-react:** Add BatchJob API support in `medusa-js` + `medusa-react` ([#1704](https://github.com/medusajs/medusa/issues/1704)) ([7302d76](https://github.com/medusajs/medusa/commit/7302d76e12683c989f340d2fcfaf4338dca6554a)) + + + + + ## [1.2.2](https://github.com/medusajs/medusa/compare/@medusajs/medusa-js@1.2.0...@medusajs/medusa-js@1.2.2) (2022-06-19) diff --git a/packages/medusa-js/package.json b/packages/medusa-js/package.json index c0029861ba..965010f3d8 100644 --- a/packages/medusa-js/package.json +++ b/packages/medusa-js/package.json @@ -1,6 +1,6 @@ { "name": "@medusajs/medusa-js", - "version": "1.2.2", + "version": "1.2.3", "description": "Client for Medusa Commerce Rest API", "main": "./dist/index.js", "types": "./dist/index.d.ts", @@ -15,7 +15,7 @@ "author": "Oliver Juhl", "license": "MIT", "dependencies": { - "@medusajs/medusa": "^1.3.2", + "@medusajs/medusa": "^1.3.3", "axios": "^0.24.0", "form-data": "^4.0.0", "qs": "^6.10.3", diff --git a/packages/medusa-payment-adyen/package.json b/packages/medusa-payment-adyen/package.json index 226620bb54..d56239d58f 100644 --- a/packages/medusa-payment-adyen/package.json +++ b/packages/medusa-payment-adyen/package.json @@ -44,5 +44,9 @@ "express": "^4.17.1", "medusa-core-utils": "^1.1.31" }, - "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808" + "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808", + "keywords": [ + "medusa-plugin", + "medusa-plugin-payment" + ] } diff --git a/packages/medusa-payment-klarna/package.json b/packages/medusa-payment-klarna/package.json index d43f6c34f4..f3a450b44e 100644 --- a/packages/medusa-payment-klarna/package.json +++ b/packages/medusa-payment-klarna/package.json @@ -43,5 +43,9 @@ "medusa-core-utils": "^1.1.31", "medusa-test-utils": "^1.1.37" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-payment" + ] } diff --git a/packages/medusa-payment-manual/package.json b/packages/medusa-payment-manual/package.json index ae19a0c87d..4316fae816 100644 --- a/packages/medusa-payment-manual/package.json +++ b/packages/medusa-payment-manual/package.json @@ -36,5 +36,9 @@ "peerDependencies": { "medusa-interfaces": "1.x" }, - "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808" + "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808", + "keywords": [ + "medusa-plugin", + "medusa-plugin-payment" + ] } diff --git a/packages/medusa-payment-paypal/CHANGELOG.md b/packages/medusa-payment-paypal/CHANGELOG.md index dbf7c2f1db..b103aabe11 100644 --- a/packages/medusa-payment-paypal/CHANGELOG.md +++ b/packages/medusa-payment-paypal/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.2.3](https://github.com/medusajs/medusa/compare/medusa-payment-paypal@1.2.2...medusa-payment-paypal@1.2.3) (2022-07-05) + +**Note:** Version bump only for package medusa-payment-paypal + + + + + ## [1.2.2](https://github.com/medusajs/medusa/compare/medusa-payment-paypal@1.2.0...medusa-payment-paypal@1.2.2) (2022-06-19) diff --git a/packages/medusa-payment-paypal/package.json b/packages/medusa-payment-paypal/package.json index d786fac643..aef686a7f5 100644 --- a/packages/medusa-payment-paypal/package.json +++ b/packages/medusa-payment-paypal/package.json @@ -1,6 +1,6 @@ { "name": "medusa-payment-paypal", - "version": "1.2.2", + "version": "1.2.3", "description": "Paypal Payment provider for Meduas Commerce", "main": "index.js", "repository": { @@ -26,7 +26,7 @@ "cross-env": "^5.2.1", "eslint": "^6.8.0", "jest": "^25.5.2", - "medusa-interfaces": "^1.3.0", + "medusa-interfaces": "^1.3.1", "medusa-test-utils": "^1.1.37" }, "scripts": { @@ -44,5 +44,9 @@ "express": "^4.17.1", "medusa-core-utils": "^1.1.31" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-payment" + ] } diff --git a/packages/medusa-payment-stripe/CHANGELOG.md b/packages/medusa-payment-stripe/CHANGELOG.md index 63eef50b4b..13593ec8ba 100644 --- a/packages/medusa-payment-stripe/CHANGELOG.md +++ b/packages/medusa-payment-stripe/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.1.41](https://github.com/medusajs/medusa/compare/medusa-payment-stripe@1.1.40...medusa-payment-stripe@1.1.41) (2022-07-05) + +**Note:** Version bump only for package medusa-payment-stripe + + + + + ## [1.1.40](https://github.com/medusajs/medusa/compare/medusa-payment-stripe@1.1.38...medusa-payment-stripe@1.1.40) (2022-06-19) diff --git a/packages/medusa-payment-stripe/package.json b/packages/medusa-payment-stripe/package.json index 45d9d95225..69302f6f8b 100644 --- a/packages/medusa-payment-stripe/package.json +++ b/packages/medusa-payment-stripe/package.json @@ -1,6 +1,6 @@ { "name": "medusa-payment-stripe", - "version": "1.1.40", + "version": "1.1.41", "description": "Stripe Payment provider for Meduas Commerce", "main": "index.js", "repository": { @@ -43,5 +43,9 @@ "medusa-core-utils": "^1.1.31", "stripe": "^8.50.0" }, - "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808" + "gitHead": "81a7ff73d012fda722f6e9ef0bd9ba0232d37808", + "keywords": [ + "medusa-plugin", + "medusa-plugin-payment" + ] } diff --git a/packages/medusa-plugin-algolia/CHANGELOG.md b/packages/medusa-plugin-algolia/CHANGELOG.md index 3d3dfddcbe..51677c32aa 100644 --- a/packages/medusa-plugin-algolia/CHANGELOG.md +++ b/packages/medusa-plugin-algolia/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [0.2.3](https://github.com/medusajs/medusa/compare/medusa-plugin-algolia@0.2.2...medusa-plugin-algolia@0.2.3) (2022-07-05) + +**Note:** Version bump only for package medusa-plugin-algolia + + + + + ## [0.2.2](https://github.com/medusajs/medusa/compare/medusa-plugin-algolia@0.2.0...medusa-plugin-algolia@0.2.2) (2022-06-19) **Note:** Version bump only for package medusa-plugin-algolia diff --git a/packages/medusa-plugin-algolia/package.json b/packages/medusa-plugin-algolia/package.json index 32958d99a4..e297904dbe 100644 --- a/packages/medusa-plugin-algolia/package.json +++ b/packages/medusa-plugin-algolia/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-algolia", - "version": "0.2.2", + "version": "0.2.3", "description": "Search support for algolia", "main": "index.js", "repository": { @@ -25,7 +25,7 @@ "body-parser": "^1.19.0", "lodash": "^4.17.21", "medusa-core-utils": "^1.1.31", - "medusa-interfaces": "^1.3.0" + "medusa-interfaces": "^1.3.1" }, "devDependencies": { "@babel/cli": "^7.7.5", @@ -42,5 +42,9 @@ "eslint": "^6.8.0", "jest": "^25.5.2" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-search" + ] } diff --git a/packages/medusa-plugin-brightpearl/CHANGELOG.md b/packages/medusa-plugin-brightpearl/CHANGELOG.md index 1d8bace5fe..e1c8152fd2 100644 --- a/packages/medusa-plugin-brightpearl/CHANGELOG.md +++ b/packages/medusa-plugin-brightpearl/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.3.1](https://github.com/medusajs/medusa/compare/medusa-plugin-brightpearl@1.3.0...medusa-plugin-brightpearl@1.3.1) (2022-07-05) + +**Note:** Version bump only for package medusa-plugin-brightpearl + + + + + # [1.3.0](https://github.com/medusajs/medusa/compare/medusa-plugin-brightpearl@1.2.1...medusa-plugin-brightpearl@1.3.0) (2022-05-01) **Note:** Version bump only for package medusa-plugin-brightpearl diff --git a/packages/medusa-plugin-brightpearl/package.json b/packages/medusa-plugin-brightpearl/package.json index 251a331ab5..036bcc91d1 100644 --- a/packages/medusa-plugin-brightpearl/package.json +++ b/packages/medusa-plugin-brightpearl/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-brightpearl", - "version": "1.3.0", + "version": "1.3.1", "description": "Brightpearl plugin for Medusa Commerce", "main": "index.js", "repository": { @@ -27,7 +27,7 @@ "cross-env": "^7.0.2", "eslint": "^6.8.0", "jest": "^25.5.2", - "medusa-interfaces": "^1.3.0", + "medusa-interfaces": "^1.3.1", "medusa-test-utils": "^1.1.37", "prettier": "^2.0.5" }, @@ -47,5 +47,9 @@ "medusa-core-utils": "^1.1.31", "randomatic": "^3.1.1" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-erp" + ] } diff --git a/packages/medusa-plugin-contentful/CHANGELOG.md b/packages/medusa-plugin-contentful/CHANGELOG.md index 19c3ba8dac..b547906cd1 100644 --- a/packages/medusa-plugin-contentful/CHANGELOG.md +++ b/packages/medusa-plugin-contentful/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.2.3](https://github.com/medusajs/medusa/compare/medusa-plugin-contentful@1.2.2...medusa-plugin-contentful@1.2.3) (2022-07-05) + +**Note:** Version bump only for package medusa-plugin-contentful + + + + + ## [1.2.2](https://github.com/medusajs/medusa/compare/medusa-plugin-contentful@1.2.0...medusa-plugin-contentful@1.2.2) (2022-06-19) **Note:** Version bump only for package medusa-plugin-contentful diff --git a/packages/medusa-plugin-contentful/package.json b/packages/medusa-plugin-contentful/package.json index a3edcdae26..cdc1f625a7 100644 --- a/packages/medusa-plugin-contentful/package.json +++ b/packages/medusa-plugin-contentful/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-contentful", - "version": "1.2.2", + "version": "1.2.3", "description": "Contentful plugin for Medusa Commerce", "main": "index.js", "repository": { @@ -43,5 +43,9 @@ "medusa-test-utils": "^1.1.37", "redis": "^3.0.2" }, - "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011" + "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011", + "keywords": [ + "medusa-plugin", + "medusa-plugin-cms" + ] } diff --git a/packages/medusa-plugin-ip-lookup/CHANGELOG.md b/packages/medusa-plugin-ip-lookup/CHANGELOG.md index e3d1e75ae2..0cfe88ff2a 100644 --- a/packages/medusa-plugin-ip-lookup/CHANGELOG.md +++ b/packages/medusa-plugin-ip-lookup/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.2.1](https://github.com/medusajs/medusa/compare/medusa-plugin-ip-lookup@1.2.0...medusa-plugin-ip-lookup@1.2.1) (2022-07-05) + + +### Bug Fixes + +* **medusa:** Remove deps `mongoose` + `mongodb` ([#1218](https://github.com/medusajs/medusa/issues/1218)) ([c76e23e](https://github.com/medusajs/medusa/commit/c76e23e84dd8cb08c3c709f9f95c4c17b9685439)) + + + + + # [1.2.0](https://github.com/medusajs/medusa/compare/medusa-plugin-ip-lookup@1.1.19...medusa-plugin-ip-lookup@1.2.0) (2022-05-01) **Note:** Version bump only for package medusa-plugin-ip-lookup diff --git a/packages/medusa-plugin-ip-lookup/package.json b/packages/medusa-plugin-ip-lookup/package.json index a6f6816585..4f3166619e 100644 --- a/packages/medusa-plugin-ip-lookup/package.json +++ b/packages/medusa-plugin-ip-lookup/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-ip-lookup", - "version": "1.2.0", + "version": "1.2.1", "description": "IP lookup middleware for Medusa core", "main": "dist/index.js", "repository": { diff --git a/packages/medusa-plugin-mailchimp/CHANGELOG.md b/packages/medusa-plugin-mailchimp/CHANGELOG.md index f4827577b2..80cff843e5 100644 --- a/packages/medusa-plugin-mailchimp/CHANGELOG.md +++ b/packages/medusa-plugin-mailchimp/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.1.42](https://github.com/medusajs/medusa/compare/medusa-plugin-mailchimp@1.1.41...medusa-plugin-mailchimp@1.1.42) (2022-07-05) + +**Note:** Version bump only for package medusa-plugin-mailchimp + + + + + ## [1.1.41](https://github.com/medusajs/medusa/compare/medusa-plugin-mailchimp@1.1.39...medusa-plugin-mailchimp@1.1.41) (2022-06-19) **Note:** Version bump only for package medusa-plugin-mailchimp diff --git a/packages/medusa-plugin-mailchimp/package.json b/packages/medusa-plugin-mailchimp/package.json index 5d92ed7723..f1e5e3d3e4 100644 --- a/packages/medusa-plugin-mailchimp/package.json +++ b/packages/medusa-plugin-mailchimp/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-mailchimp", - "version": "1.1.41", + "version": "1.1.42", "description": "Mailchimp newsletter subscriptions", "main": "index.js", "repository": { @@ -43,5 +43,9 @@ "medusa-core-utils": "^1.1.31", "medusa-test-utils": "^1.1.37" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-notification" + ] } diff --git a/packages/medusa-plugin-meilisearch/CHANGELOG.md b/packages/medusa-plugin-meilisearch/CHANGELOG.md index 0e32b29c57..24a0d25c90 100644 --- a/packages/medusa-plugin-meilisearch/CHANGELOG.md +++ b/packages/medusa-plugin-meilisearch/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [0.2.3](https://github.com/medusajs/medusa/compare/medusa-plugin-meilisearch@0.2.2...medusa-plugin-meilisearch@0.2.3) (2022-07-05) + + +### Bug Fixes + +* **meilisearch:** remove medusa-interfaces dependency ([#1751](https://github.com/medusajs/medusa/issues/1751)) ([f7e300e](https://github.com/medusajs/medusa/commit/f7e300e8cec082cab23626907333682e9a643238)) + + + + + ## [0.2.2](https://github.com/medusajs/medusa/compare/medusa-plugin-meilisearch@0.2.0...medusa-plugin-meilisearch@0.2.2) (2022-06-19) **Note:** Version bump only for package medusa-plugin-meilisearch diff --git a/packages/medusa-plugin-meilisearch/package.json b/packages/medusa-plugin-meilisearch/package.json index df28269147..72a9bb9322 100644 --- a/packages/medusa-plugin-meilisearch/package.json +++ b/packages/medusa-plugin-meilisearch/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-meilisearch", - "version": "0.2.2", + "version": "0.2.3", "description": "A starter for Medusa projects.", "main": "index.js", "repository": { @@ -40,5 +40,9 @@ "eslint": "^6.8.0", "jest": "^25.5.2" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-search" + ] } diff --git a/packages/medusa-plugin-restock-notification/package.json b/packages/medusa-plugin-restock-notification/package.json index d8a3c82486..ebb659a783 100644 --- a/packages/medusa-plugin-restock-notification/package.json +++ b/packages/medusa-plugin-restock-notification/package.json @@ -38,5 +38,9 @@ "express": "^4.17.1", "medusa-core-utils": "^1.1.31" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-notification" + ] } diff --git a/packages/medusa-plugin-segment/package.json b/packages/medusa-plugin-segment/package.json index c859d2b8ce..6a515fbdec 100644 --- a/packages/medusa-plugin-segment/package.json +++ b/packages/medusa-plugin-segment/package.json @@ -42,5 +42,9 @@ "medusa-core-utils": "^1.1.31", "medusa-test-utils": "^1.1.37" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-analytics" + ] } diff --git a/packages/medusa-plugin-sendgrid/CHANGELOG.md b/packages/medusa-plugin-sendgrid/CHANGELOG.md index c5478aee8b..3d98b10585 100644 --- a/packages/medusa-plugin-sendgrid/CHANGELOG.md +++ b/packages/medusa-plugin-sendgrid/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.3.3](https://github.com/medusajs/medusa/compare/medusa-plugin-sendgrid@1.3.2...medusa-plugin-sendgrid@1.3.3) (2022-07-05) + +**Note:** Version bump only for package medusa-plugin-sendgrid + + + + + ## [1.3.2](https://github.com/medusajs/medusa/compare/medusa-plugin-sendgrid@1.3.0...medusa-plugin-sendgrid@1.3.2) (2022-06-19) **Note:** Version bump only for package medusa-plugin-sendgrid diff --git a/packages/medusa-plugin-sendgrid/package.json b/packages/medusa-plugin-sendgrid/package.json index 2b72f4ff0c..ec4ddc5402 100644 --- a/packages/medusa-plugin-sendgrid/package.json +++ b/packages/medusa-plugin-sendgrid/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-sendgrid", - "version": "1.3.2", + "version": "1.3.3", "description": "SendGrid transactional emails", "main": "index.js", "repository": { @@ -42,5 +42,9 @@ "medusa-core-utils": "^1.1.31", "medusa-test-utils": "^1.1.37" }, - "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011" + "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011", + "keywords": [ + "medusa-plugin", + "medusa-plugin-notification" + ] } diff --git a/packages/medusa-plugin-slack-notification/CHANGELOG.md b/packages/medusa-plugin-slack-notification/CHANGELOG.md index b78ce19eda..10026026d5 100644 --- a/packages/medusa-plugin-slack-notification/CHANGELOG.md +++ b/packages/medusa-plugin-slack-notification/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.3.3](https://github.com/medusajs/medusa/compare/medusa-plugin-slack-notification@1.3.2...medusa-plugin-slack-notification@1.3.3) (2022-07-05) + +**Note:** Version bump only for package medusa-plugin-slack-notification + + + + + ## [1.3.2](https://github.com/medusajs/medusa/compare/medusa-plugin-slack-notification@1.3.0...medusa-plugin-slack-notification@1.3.2) (2022-06-19) **Note:** Version bump only for package medusa-plugin-slack-notification diff --git a/packages/medusa-plugin-slack-notification/package-lock.json b/packages/medusa-plugin-slack-notification/package-lock.json index c8c4d67df4..8cc47a39ec 100644 --- a/packages/medusa-plugin-slack-notification/package-lock.json +++ b/packages/medusa-plugin-slack-notification/package-lock.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-economic", - "version": "1.3.2", + "version": "1.3.3", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/medusa-plugin-slack-notification/package.json b/packages/medusa-plugin-slack-notification/package.json index b28720ef74..ee70e707ce 100644 --- a/packages/medusa-plugin-slack-notification/package.json +++ b/packages/medusa-plugin-slack-notification/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-slack-notification", - "version": "1.3.2", + "version": "1.3.3", "description": "Slack notifications", "main": "index.js", "repository": { @@ -43,5 +43,9 @@ "medusa-test-utils": "^1.1.37", "moment": "^2.27.0" }, - "gitHead": "c46300d58fbfd0b2dc2c02745ae143e6247e885b" + "gitHead": "c46300d58fbfd0b2dc2c02745ae143e6247e885b", + "keywords": [ + "medusa-plugin", + "medusa-plugin-notification" + ] } diff --git a/packages/medusa-plugin-twilio-sms/CHANGELOG.md b/packages/medusa-plugin-twilio-sms/CHANGELOG.md index 77253b896f..aaa10e6cc5 100644 --- a/packages/medusa-plugin-twilio-sms/CHANGELOG.md +++ b/packages/medusa-plugin-twilio-sms/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.2.3](https://github.com/medusajs/medusa/compare/medusa-plugin-twilio-sms@1.2.2...medusa-plugin-twilio-sms@1.2.3) (2022-07-05) + +**Note:** Version bump only for package medusa-plugin-twilio-sms + + + + + ## [1.2.2](https://github.com/medusajs/medusa/compare/medusa-plugin-twilio-sms@1.2.0...medusa-plugin-twilio-sms@1.2.2) (2022-06-19) **Note:** Version bump only for package medusa-plugin-twilio-sms diff --git a/packages/medusa-plugin-twilio-sms/package.json b/packages/medusa-plugin-twilio-sms/package.json index 3397a9e223..8d59982d21 100644 --- a/packages/medusa-plugin-twilio-sms/package.json +++ b/packages/medusa-plugin-twilio-sms/package.json @@ -1,6 +1,6 @@ { "name": "medusa-plugin-twilio-sms", - "version": "1.2.2", + "version": "1.2.3", "main": "index.js", "repository": { "type": "git", @@ -39,5 +39,9 @@ "medusa-test-utils": "^1.1.37", "twilio": "^3.49.1" }, - "gitHead": "c46300d58fbfd0b2dc2c02745ae143e6247e885b" + "gitHead": "c46300d58fbfd0b2dc2c02745ae143e6247e885b", + "keywords": [ + "medusa-plugin", + "medusa-plugin-notification" + ] } diff --git a/packages/medusa-plugin-wishlist/package.json b/packages/medusa-plugin-wishlist/package.json index 70a0734ea7..4e26a87595 100644 --- a/packages/medusa-plugin-wishlist/package.json +++ b/packages/medusa-plugin-wishlist/package.json @@ -41,5 +41,8 @@ "medusa-core-utils": "^1.1.31", "medusa-test-utils": "^1.1.37" }, - "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011" + "gitHead": "3bbd1e8507e00bc471de6ae3c30207999a4a4011", + "keywords": [ + "medusa-plugin" + ] } diff --git a/packages/medusa-react/CHANGELOG.md b/packages/medusa-react/CHANGELOG.md index 4c9b77a0d1..107334133d 100644 --- a/packages/medusa-react/CHANGELOG.md +++ b/packages/medusa-react/CHANGELOG.md @@ -3,6 +3,22 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [0.3.3](https://github.com/medusajs/medusa/compare/medusa-react@0.3.2...medusa-react@0.3.3) (2022-07-05) + + +### Bug Fixes + +* **medusa-react:** Allow to not invalidate any cache ([#1756](https://github.com/medusajs/medusa/issues/1756)) ([9e0f65d](https://github.com/medusajs/medusa/commit/9e0f65dee3b3329eb4eabe093f44a8e3b7d6e820)) + + +### Features + +* **medusa,medusa-js,medusa-react:** Add BatchJob API support in `medusa-js` + `medusa-react` ([#1704](https://github.com/medusajs/medusa/issues/1704)) ([7302d76](https://github.com/medusajs/medusa/commit/7302d76e12683c989f340d2fcfaf4338dca6554a)) + + + + + ## [0.3.2](https://github.com/medusajs/medusa/compare/medusa-react@0.3.0...medusa-react@0.3.2) (2022-06-19) diff --git a/packages/medusa-react/package.json b/packages/medusa-react/package.json index 287231c6da..80bf0381fc 100644 --- a/packages/medusa-react/package.json +++ b/packages/medusa-react/package.json @@ -1,5 +1,5 @@ { - "version": "0.3.2", + "version": "0.3.3", "license": "MIT", "main": "dist/index.js", "typings": "dist/index.d.ts", @@ -22,9 +22,9 @@ "build-storybook": "build-storybook" }, "peerDependencies": { + "@medusajs/medusa": "^1.3.2", "react": ">=16", - "react-query": ">= 3.29.0", - "@medusajs/medusa": "^1.3.2" + "react-query": ">= 3.29.0" }, "husky": { "hooks": { @@ -81,7 +81,7 @@ "typescript": "^4.5.2" }, "dependencies": { - "@medusajs/medusa-js": "^1.2.2", + "@medusajs/medusa-js": "^1.2.3", "lodash": "^4.17.21", "lodash-es": "^4.17.21", "react-query": "^3.31.0" diff --git a/packages/medusa-source-shopify/CHANGELOG.md b/packages/medusa-source-shopify/CHANGELOG.md index 559114ce99..86aa1a05d7 100644 --- a/packages/medusa-source-shopify/CHANGELOG.md +++ b/packages/medusa-source-shopify/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.2.1](https://github.com/medusajs/medusa/compare/medusa-source-shopify@1.2.0...medusa-source-shopify@1.2.1) (2022-07-05) + +**Note:** Version bump only for package medusa-source-shopify + + + + + # [1.2.0](https://github.com/medusajs/medusa/compare/medusa-source-shopify@1.1.1...medusa-source-shopify@1.2.0) (2022-05-01) diff --git a/packages/medusa-source-shopify/package.json b/packages/medusa-source-shopify/package.json index 22e17f61cf..206494459e 100644 --- a/packages/medusa-source-shopify/package.json +++ b/packages/medusa-source-shopify/package.json @@ -1,6 +1,6 @@ { "name": "medusa-source-shopify", - "version": "1.2.0", + "version": "1.2.1", "description": "Source plugin that allows users to import products from a Shopify store", "main": "index.js", "repository": { @@ -29,7 +29,7 @@ "ioredis": "^4.27.9", "lodash": "^4.17.21", "medusa-core-utils": "^1.1.31", - "medusa-interfaces": "^1.3.0", + "medusa-interfaces": "^1.3.1", "medusa-test-utils": "^1.1.37" }, "devDependencies": { @@ -47,5 +47,9 @@ "eslint": "^7.32.0", "jest": "^26.6.3" }, - "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e" + "gitHead": "cd1f5afa5aa8c0b15ea957008ee19f1d695cbd2e", + "keywords": [ + "medusa-plugin", + "medusa-plugin-source" + ] } diff --git a/packages/medusa/CHANGELOG.md b/packages/medusa/CHANGELOG.md index 375d9b2cdb..86c66f1866 100644 --- a/packages/medusa/CHANGELOG.md +++ b/packages/medusa/CHANGELOG.md @@ -3,6 +3,49 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## [1.3.3](https://github.com/medusajs/medusa/compare/@medusajs/medusa@1.3.2...@medusajs/medusa@1.3.3) (2022-07-05) + + +### Bug Fixes + +* introduce listAndCount for gift cards to enable pagination ([#1754](https://github.com/medusajs/medusa/issues/1754)) ([9a14b84](https://github.com/medusajs/medusa/commit/9a14b84e58a7db2b38edaf9ce59dcb4416736c30)) +* **medusa:** Remove deps `mongoose` + `mongodb` ([#1218](https://github.com/medusajs/medusa/issues/1218)) ([c76e23e](https://github.com/medusajs/medusa/commit/c76e23e84dd8cb08c3c709f9f95c4c17b9685439)) +* add shipping taxes ([#1759](https://github.com/medusajs/medusa/issues/1759)) ([fee0f88](https://github.com/medusajs/medusa/commit/fee0f88a62d7e00c844fcd021d090f130ab4a532)) +* **medusa:** Add images relation ([#1693](https://github.com/medusajs/medusa/issues/1693)) ([765c794](https://github.com/medusajs/medusa/commit/765c794b9775a12fffbed59a6312beb87442dc1a)) +* **medusa:** Normalizes email before saving customer ([#1719](https://github.com/medusajs/medusa/issues/1719)) ([2a32609](https://github.com/medusajs/medusa/commit/2a32609b7458c12f047d3f9ba45d426fdc784d58)) +* **medusa:** Plugin loader must also check for TransactionBaseService ([#1601](https://github.com/medusajs/medusa/issues/1601)) ([28ddf10](https://github.com/medusajs/medusa/commit/28ddf10446e689a32bf9d4d05dedd4aa090d66a0)) +* **medusa:** Product export strategy ([#1713](https://github.com/medusajs/medusa/issues/1713)) ([89cb717](https://github.com/medusajs/medusa/commit/89cb7174613ffbced8abb3a7e8a4539134bd867c)) +* **medusa:** Remove duplicate DiscountRuleType import ([#1699](https://github.com/medusajs/medusa/issues/1699)) ([46a6e1a](https://github.com/medusajs/medusa/commit/46a6e1a4d368241288d50cdd0aa35ac7dbf14764)) +* **medusa:** update cron schedule to be every 6 hours ([#1658](https://github.com/medusajs/medusa/issues/1658)) ([cffb03d](https://github.com/medusajs/medusa/commit/cffb03d1978b6fe019007f9c7683b67171300255)) +* adds tax calculation to product pricing ([#1354](https://github.com/medusajs/medusa/issues/1354)) ([14366f5](https://github.com/medusajs/medusa/commit/14366f536decc88546658e23521961a82409e842)) +* includes variant prices when listing products using a search query ([#1607](https://github.com/medusajs/medusa/issues/1607)) ([247ad6d](https://github.com/medusajs/medusa/commit/247ad6dc6d7f55bdec5d9d1b59f96c380dbba9c9)) + + +### Features + +* add customer to fetch-draft-order payload ([#1444](https://github.com/medusajs/medusa/issues/1444)) ([3fb74bf](https://github.com/medusajs/medusa/commit/3fb74bf512644c4dc45615a608f27650a95fa791)) +* **medusa:** Add batch strategy for order exports ([#1603](https://github.com/medusajs/medusa/issues/1603)) ([bf47d1a](https://github.com/medusajs/medusa/commit/bf47d1aecd74f4489667609444a8b09393e894d3)) +* **medusa:** Add file size calculation for product export ([#1726](https://github.com/medusajs/medusa/issues/1726)) ([fb7abbf](https://github.com/medusajs/medusa/commit/fb7abbf40784dcc66dbde25d400f3af54141c237)) +* **medusa:** Add line item totals to cart totals decoration ([#1740](https://github.com/medusajs/medusa/issues/1740)) ([c6dc908](https://github.com/medusajs/medusa/commit/c6dc9086cfa272db0c1a7f98f670bd3ed8ccfa78)) +* **medusa:** Allow to filter the batch jobs with nullable date ([#1747](https://github.com/medusajs/medusa/issues/1747)) ([c0f624a](https://github.com/medusajs/medusa/commit/c0f624ad3b8ae507438c0c84d867dc19904f08ae)) +* **medusa:** Apply query transformers to Collection and CustomerGroups ([#1667](https://github.com/medusajs/medusa/issues/1667)) ([e53c06e](https://github.com/medusajs/medusa/commit/e53c06eab8a37579f33c547d0373edc082cc308b)) +* **medusa:** BatchJobStrategy and loaders ([#1434](https://github.com/medusajs/medusa/issues/1434)) ([886dcbc](https://github.com/medusajs/medusa/commit/886dcbc82fc5ec784e699ddf7b18f710535fdada)) +* **medusa:** Convert GiftCardService to Typescript ([#1664](https://github.com/medusajs/medusa/issues/1664)) ([1585b7a](https://github.com/medusajs/medusa/commit/1585b7ae2b063adad9c22f6aac9d1e426ccac29f)) +* **medusa:** Delete and download url endpoints ([#1705](https://github.com/medusajs/medusa/issues/1705)) ([cc29b64](https://github.com/medusajs/medusa/commit/cc29b641c9358415b46179371988e7ddc11d2664)) +* **medusa:** Extend file-service interface + move to core ([#1577](https://github.com/medusajs/medusa/issues/1577)) ([8e42d37](https://github.com/medusajs/medusa/commit/8e42d37e84e80c003b9c0311117ab8a8871aa61b)) +* **medusa:** Migrate utils to TS ([#1415](https://github.com/medusajs/medusa/issues/1415)) ([d98cd85](https://github.com/medusajs/medusa/commit/d98cd85d2370f179044ddfec43479dc7cdcc39bd)) +* **medusa:** Parsing CSV files ([#1572](https://github.com/medusajs/medusa/issues/1572)) ([9e686a8](https://github.com/medusajs/medusa/commit/9e686a8e47c567ffdb57bb43af796dd38049294f)) +* **medusa:** Support batch-job API ([#1547](https://github.com/medusajs/medusa/issues/1547)) ([4536886](https://github.com/medusajs/medusa/commit/453688682c79032737ea47197c00ea14e84aab02)), closes [#1434](https://github.com/medusajs/medusa/issues/1434) [#1548](https://github.com/medusajs/medusa/issues/1548) [#1453](https://github.com/medusajs/medusa/issues/1453) +* **medusa:** Support transformQuery/Body middleware, introduction of pipe feature ([#1593](https://github.com/medusajs/medusa/issues/1593)) ([3359e18](https://github.com/medusajs/medusa/commit/3359e189a70533692f85fbbff9b09018872abbf4)) +* **medusa:** Update BuildQuery typings ([#1672](https://github.com/medusajs/medusa/issues/1672)) ([93aaaa7](https://github.com/medusajs/medusa/commit/93aaaa71bd07ba0675be05ea503580f3e9ec6806)) +* **medusa-cli:** Allow to revert migrations from the CLI ([#1353](https://github.com/medusajs/medusa/issues/1353)) ([012513b](https://github.com/medusajs/medusa/commit/012513b6a1e90169e9e0e53f7a59841a34fbaeb3)) +* **medusa,medusa-js,medusa-react:** Add BatchJob API support in `medusa-js` + `medusa-react` ([#1704](https://github.com/medusajs/medusa/issues/1704)) ([7302d76](https://github.com/medusajs/medusa/commit/7302d76e12683c989f340d2fcfaf4338dca6554a)) +* **medusa/product-export-strategy:** Implement the Product export strategy ([#1688](https://github.com/medusajs/medusa/issues/1688)) ([7b09b8c](https://github.com/medusajs/medusa/commit/7b09b8c36cf8777ee874deed795bc98ba6653aa8)) + + + + + ## [1.3.2](https://github.com/medusajs/medusa/compare/@medusajs/medusa@1.3.0...@medusajs/medusa@1.3.2) (2022-06-19) diff --git a/packages/medusa/package.json b/packages/medusa/package.json index 94604fdb61..73f0e381de 100644 --- a/packages/medusa/package.json +++ b/packages/medusa/package.json @@ -1,6 +1,6 @@ { "name": "@medusajs/medusa", - "version": "1.3.2", + "version": "1.3.3", "description": "E-commerce for JAMstack", "main": "dist/index.js", "bin": { @@ -21,14 +21,14 @@ "@babel/core": "^7.14.3", "@babel/preset-typescript": "^7.13.0", "@types/express": "^4.17.13", - "@types/multer": "^1.4.7", "@types/jest": "^27.5.0", "@types/jsonwebtoken": "^8.5.5", + "@types/multer": "^1.4.7", "babel-preset-medusa-package": "^1.1.19", "cross-env": "^5.2.1", "eslint": "^7.32.0", "jest": "^25.5.2", - "medusa-interfaces": "^1.3.0", + "medusa-interfaces": "^1.3.1", "nodemon": "^2.0.1", "prettier": "^1.19.1", "sqlite3": "^5.0.2", @@ -51,7 +51,7 @@ }, "dependencies": { "@hapi/joi": "^16.1.8", - "@medusajs/medusa-cli": "^1.3.0", + "@medusajs/medusa-cli": "^1.3.1", "@types/lodash": "^4.14.168", "awilix": "^4.2.3", "body-parser": "^1.19.0", diff --git a/www/docs/sidebars.js b/www/docs/sidebars.js index ec0e634050..ec3cb36aa2 100644 --- a/www/docs/sidebars.js +++ b/www/docs/sidebars.js @@ -68,36 +68,66 @@ module.exports = { }, { type: "doc", - id: "how-to/create-medusa-app", + id: "usage/create-medusa-app", }, { type: "category", label: "Deployment", items: [ { - type: "doc", - id: "how-to/deploying-on-heroku", - label: "Deploy: Heroku", + type: "category", + label: "Server", + link: { + type: "doc", + id: "deployments/server/index" + }, + items: [ + { + type: "doc", + id: "deployments/server/deploying-on-heroku", + label: "Deploy on Heroku" + }, + { + type: "doc", + id: "deployments/server/deploying-on-digital-ocean", + label: "Deploy on DigitalOcean" + }, + { + type: "doc", + id: "deployments/server/deploying-on-qovery", + label: "Deploy on Qovery" + } + ] }, { - type: "doc", - id: "how-to/deploying-on-qovery", - label: "Deploy: Qovery", + type: "category", + label: "Admin", + link: { + type: "doc", + id: "deployments/admin/index" + }, + items: [ + { + type: "doc", + id: "deployments/admin/deploying-on-netlify", + label: "Deploy on Netlify" + }, + ] }, { - type: "doc", - id: "how-to/deploying-on-digital-ocean", - label: "Deploy: DigitalOcean", - }, - { - type: "doc", - id: "how-to/deploying-admin-on-netlify", - label: "Deploy: Admin on Netlify", - }, - { - type: "doc", - id: "how-to/deploying-gatsby-on-netlify", - label: "Deploy: Gatsby on Netlify", + type: "category", + label: "Storefront", + link: { + type: "doc", + id: "deployments/storefront/index" + }, + items: [ + { + type: "doc", + id: "deployments/storefront/deploying-gatsby-on-netlify", + label: "Deploy Gatsby on Netlify" + }, + ] }, ], }, @@ -279,17 +309,6 @@ module.exports = { }, ], }, - { - type: "category", - label: "Bot", - items: [ - { - type: "doc", - id: "add-plugins/slack", - label: "Slack", - }, - ], - }, { type: "category", label: "CMS", @@ -339,6 +358,11 @@ module.exports = { id: "add-plugins/twilio-sms", label: "Twilio SMS", }, + { + type: "doc", + id: "add-plugins/slack", + label: "Slack", + }, ], }, { @@ -437,6 +461,11 @@ module.exports = { }, ], }, + { + type: "doc", + id: "cli/reference", + label: "CLI Reference", + }, { type: "doc", id: "contribution-guidelines", diff --git a/www/docs/src/css/custom.css b/www/docs/src/css/custom.css index 4fe42e05f1..579e5b1c15 100644 --- a/www/docs/src/css/custom.css +++ b/www/docs/src/css/custom.css @@ -144,7 +144,7 @@ article { } @media screen and (min-width: 966px) { - article { + [class*=docItemContainer] > article { margin-left: 50px; margin-right: 50px; max-width: none diff --git a/yarn.lock b/yarn.lock index af4a0294fd..d8eae4c09a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -6274,11 +6274,6 @@ resolved "https://registry.npmjs.org/@sindresorhus/is/-/is-0.14.0.tgz" integrity sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ== -"@sindresorhus/is@^2.0.0": - version "2.1.1" - resolved "https://registry.npmjs.org/@sindresorhus/is/-/is-2.1.1.tgz" - integrity sha512-/aPsuoj/1Dw/kzhkgz+ES6TxG0zfTMGLwuK2ZG00k/iJzYHTLCE8mVU8EPqEOp/lmxPoq1C1C9RYToRKb2KEfg== - "@sindresorhus/is@^4.0.0": version "4.2.1" resolved "https://registry.npmjs.org/@sindresorhus/is/-/is-4.2.1.tgz" @@ -7495,7 +7490,7 @@ dependencies: defer-to-connect "^1.0.1" -"@szmarczak/http-timer@^4.0.0", "@szmarczak/http-timer@^4.0.5": +"@szmarczak/http-timer@^4.0.5": version "4.0.6" resolved "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-4.0.6.tgz" integrity sha512-4BAffykYOgO+5nzBWYwE3W90sBgLJoUPRWWcL8wlyiM8IB8ipJz3UMJ9KXQd1RKQXpKp8Tutn80HZtWsu2u76w== @@ -7948,7 +7943,7 @@ dependencies: "@types/node" "*" -"@types/keyv@*", "@types/keyv@^3.1.1": +"@types/keyv@*": version "3.1.3" resolved "https://registry.npmjs.org/@types/keyv/-/keyv-3.1.3.tgz" integrity sha512-FXCJgyyN3ivVgRoml4h94G/p3kY+u/B86La+QptcqJaWtBWtmc6TtkNfS40n9bIvyLteHh7zXOtgbobORKPbDg== @@ -10894,14 +10889,6 @@ cache-manager@^2.11.1: lodash.clonedeep "4.5.0" lru-cache "4.0.0" -cacheable-lookup@^2.0.0: - version "2.0.1" - resolved "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-2.0.1.tgz" - integrity sha512-EMMbsiOTcdngM/K6gV/OxF2x0t07+vMOWxZNSCRQMjO2MY2nhZQ6OYhOOpyQrbhqsgtvKGI7hcq6xjnA92USjg== - dependencies: - "@types/keyv" "^3.1.1" - keyv "^4.0.0" - cacheable-lookup@^5.0.3: version "5.0.4" resolved "https://registry.npmjs.org/cacheable-lookup/-/cacheable-lookup-5.0.4.tgz" @@ -10920,7 +10907,7 @@ cacheable-request@^6.0.0: normalize-url "^4.1.0" responselike "^1.0.2" -cacheable-request@^7.0.1, cacheable-request@^7.0.2: +cacheable-request@^7.0.2: version "7.0.2" resolved "https://registry.npmjs.org/cacheable-request/-/cacheable-request-7.0.2.tgz" integrity sha512-pouW8/FmiPQbuGpkXQ9BAPv/Mo5xDGANgSNXzTzJ8DrKGuXOssM4wIQRjfanNRh3Yu5cfYPvcorqbhg2KIJtew== @@ -12791,13 +12778,6 @@ decompress-response@^3.3.0: dependencies: mimic-response "^1.0.0" -decompress-response@^5.0.0: - version "5.0.0" - resolved "https://registry.npmjs.org/decompress-response/-/decompress-response-5.0.0.tgz" - integrity sha512-TLZWWybuxWgoW7Lykv+gq9xvzOsUjQ9tF09Tj6NSTYGMTCHNXzrPnD6Hi+TgZq19PyTAGH4Ll/NIM/eTGglnMw== - dependencies: - mimic-response "^2.0.0" - decompress-response@^6.0.0: version "6.0.0" resolved "https://registry.npmjs.org/decompress-response/-/decompress-response-6.0.0.tgz" @@ -16187,31 +16167,10 @@ good-listener@^1.2.2: dependencies: delegate "^3.1.2" -got@^10.7.0: - version "10.7.0" - resolved "https://registry.npmjs.org/got/-/got-10.7.0.tgz" - integrity sha512-aWTDeNw9g+XqEZNcTjMMZSy7B7yE9toWOFYip7ofFTLleJhvZwUxxTxkTpKvF+p1SAA4VHmuEy7PiHTHyq8tJg== - dependencies: - "@sindresorhus/is" "^2.0.0" - "@szmarczak/http-timer" "^4.0.0" - "@types/cacheable-request" "^6.0.1" - cacheable-lookup "^2.0.0" - cacheable-request "^7.0.1" - decompress-response "^5.0.0" - duplexer3 "^0.1.4" - get-stream "^5.0.0" - lowercase-keys "^2.0.0" - mimic-response "^2.1.0" - p-cancelable "^2.0.0" - p-event "^4.0.0" - responselike "^2.0.0" - to-readable-stream "^2.0.0" - type-fest "^0.10.0" - -got@^11.8.2, got@^11.8.3: - version "11.8.3" - resolved "https://registry.npmjs.org/got/-/got-11.8.3.tgz" - integrity sha512-7gtQ5KiPh1RtGS9/Jbv1ofDpBFuq42gyfEib+ejaRBJuj/3tQFeR5+gw57e4ipaU8c/rCjvX6fkQz2lyDlGAOg== +got@^11.8.2, got@^11.8.3, got@^11.8.5: + version "11.8.5" + resolved "https://registry.yarnpkg.com/got/-/got-11.8.5.tgz#ce77d045136de56e8f024bebb82ea349bc730046" + integrity sha512-o0Je4NvQObAuZPHLFoRSkdG2lTgtcynqymzg2Vupdx6PorhaT5MCbIyXG6d4D94kk8ZG57QeosgdiqfJWhEhlQ== dependencies: "@sindresorhus/is" "^4.0.0" "@szmarczak/http-timer" "^4.0.5" @@ -21015,11 +20974,6 @@ mimic-response@^1.0.0, mimic-response@^1.0.1: resolved "https://registry.npmjs.org/mimic-response/-/mimic-response-1.0.1.tgz" integrity sha512-j5EctnkH7amfV/q5Hgmoal1g2QHFJRraOtmx0JpIqkxhBhI/lJSl1nMpQ45hVarwNETOoWEimndZ4QK0RHxuxQ== -mimic-response@^2.0.0, mimic-response@^2.1.0: - version "2.1.0" - resolved "https://registry.npmjs.org/mimic-response/-/mimic-response-2.1.0.tgz" - integrity sha512-wXqjST+SLt7R009ySCglWBCFpjUygmCIfD790/kVbiGmUgfYGuB14PiTd5DwVxSV4NcYHjzMkoj5LjQZwTQLEA== - mimic-response@^3.1.0: version "3.1.0" resolved "https://registry.npmjs.org/mimic-response/-/mimic-response-3.1.0.tgz" @@ -22376,7 +22330,7 @@ p-each-series@^2.1.0: resolved "https://registry.npmjs.org/p-each-series/-/p-each-series-2.2.0.tgz" integrity sha512-ycIL2+1V32th+8scbpTvyHNaHe02z0sjgh91XXjAk+ZeXoPN4Z46DVUnzdso0aX4KckKw0FNNFHdjZ2UsZvxiA== -p-event@^4.0.0, p-event@^4.1.0: +p-event@^4.1.0: version "4.2.0" resolved "https://registry.npmjs.org/p-event/-/p-event-4.2.0.tgz" integrity sha512-KXatOjCRXXkSePPb1Nbi0p0m+gQAwdlbhi4wQKJPI1HsMQS9g+Sqp2o+QHziPr7eYJyOZet836KoHEVM1mwOrQ== @@ -27516,11 +27470,6 @@ to-readable-stream@^1.0.0: resolved "https://registry.npmjs.org/to-readable-stream/-/to-readable-stream-1.0.0.tgz" integrity sha512-Iq25XBt6zD5npPhlLVXGFN3/gyR2/qODcKNNyTMd4vbm39HUaOiAM4PMq0eMVC/Tkxz+Zjdsc55g9yyz+Yq00Q== -to-readable-stream@^2.0.0: - version "2.1.0" - resolved "https://registry.npmjs.org/to-readable-stream/-/to-readable-stream-2.1.0.tgz" - integrity sha512-o3Qa6DGg1CEXshSdvWNX2sN4QHqg03SPq7U6jPXRahlQdl5dK8oXjkU/2/sGrnOZKeGV1zLSO8qPwyKklPPE7w== - to-regex-range@^2.1.0: version "2.1.1" resolved "https://registry.npmjs.org/to-regex-range/-/to-regex-range-2.1.1.tgz" @@ -27948,11 +27897,6 @@ type-fest@0.15.1: resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.15.1.tgz" integrity sha512-n+UXrN8i5ioo7kqT/nF8xsEzLaqFra7k32SEsSPwvXVGyAcRgV/FUQN/sgfptJTR1oRmmq7z4IXMFSM7im7C9A== -type-fest@^0.10.0: - version "0.10.0" - resolved "https://registry.npmjs.org/type-fest/-/type-fest-0.10.0.tgz" - integrity sha512-EUV9jo4sffrwlg8s0zDhP0T2WD3pru5Xi0+HTE3zTUmBaZNhfkite9PdSJwdXLwPVW0jnAHT56pZHIOYckPEiw== - type-fest@^0.13.1: version "0.13.1" resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.13.1.tgz#0172cb5bce80b0bd542ea348db50c7e21834d934"