docs: improve Deploy Admin to Netlify documentation (#1757)

* changes to deployment pages structure

* fix sidebar links

* added button to quickstart

* comment out button

* comment out button

* added note

* small fixes

* small fixes
This commit is contained in:
Shahed Nasser
2022-06-30 18:27:01 +03:00
committed by GitHub
parent de2390e5df
commit 109afa45c1
18 changed files with 375 additions and 122 deletions
@@ -0,0 +1,71 @@
---
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](../../usage/create-medusa-app.mdx) 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).
@@ -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.
<DocCardList items={useCurrentSidebarCategory().items}/>