feat: Update to API references look and feel (#343)

Co-authored-by: Vadim Smirnov <smirnou.vadzim@gmail.com> Co-authored-by: zakariasaad <zakaria.elas@gmail.com> Co-authored-by: Vilfred Sikker <vilfredsikker@gmail.com> Co-authored-by: olivermrbl <oliver@mrbltech.com>
2021-08-20 10:26:29 +02:00
parent 40400b483c
commit 143f06aa39
85 changed files with 19022 additions and 7116 deletions
@@ -5308,7 +5308,7 @@
        }
      }
    },
-    "/returns/{id}receive": {
+    "/returns/{id}/receive": {
      "post": {
        "operationId": "PostReturnsReturnReceive",
        "summary": "Receive a Return",
@@ -5881,7 +5881,7 @@
      },
      "delete": {
        "operationId": "DeleteStoreCurrenciesCode",
-        "summary": "Remvoe a Currency Code",
+        "summary": "Remove a Currency Code",
        "description": "Removes a Currency Code from the available currencies.",
        "parameters": [
          {
@@ -6085,7 +6085,7 @@
    "/variants": {
      "get": {
        "operationId": "GetVariants",
-        "summary": "List Product Variants.",
+        "summary": "List Product Variants",
        "description": "Retrieves a list of Product Variants",
        "tags": [
          "Product Variant"
@@ -7546,7 +7546,7 @@
          "swaps": {
            "type": "array",
            "items": {
-              "$ref": "#/components/schemas/refund"
+              "$ref": "#/components/schemas/swap"
            }
          },
          "gift_card_transactions": {
@@ -955,4 +955,4 @@
      "idempotency_key": "10804103-2f4f-41ef-b44e-7049459f157d"
    }
  }
-}
+}
@@ -0,0 +1,41 @@
+- title: Tutorials
+  id: tutorials
+  items:
+    - id: overview
+      title: Overview
+    - id: getting-started
+      title: Getting started
+    - id: adding-plugins
+      title: Adding plugins
+    - id: creating-a-custom-endpoint
+      title: Creating a custom endpoint
+    - id: linking-medusa-cloud
+      title: Linking Medusa Cloud
+- title: Guides
+  id: guides
+  items:
+    - id: overview
+      title: Overview
+    - id: local-development
+      title: Local development
+      items:
+        - id: overview
+          title: Overview
+        - id: create-project-from-starter
+          title: Create project from starter
+          items:
+            - id: medusa-starter
+              title: Medusa starter
+            - id: gatsby-starter-medusa
+              title: Gatsby starter
+        - id: environment-variables
+          title: Environment variables
+- title: Reference
+  id: reference
+  items:
+    - id: admin
+      title: admin
+    - id: store
+      title: store
+- title: Contributing
+  id: contributing
@@ -0,0 +1,89 @@
+---
+title: Getting started
+---
+# Quick Start w. Docker
+
+This quick start is intended for developers, that have already configured their local development environment and familiarised them selves with all the technologies and frameworks used throughout the Medusa eco-system.
+
+If this is not the case, please head over to our Getting Started tutorial for a thorough walkthrough.
+
+## Introduction
+
+With all the tools and technologies in place, let's get started by setting up a default project. Our starter is shipped with a very basic configuration, that includes the following plugins:
+
+- Stripe as payment provider
+- SendGrid as email notification provider
+- Manual fulfilment as fulfilment provider
+
+Additionally, we will spin up a PostgreSQL database and a Redis server, both required for Medusa to run. In this quick start, we will use docker to seamlessly set up these resources.
+
+## Get started
+
+1. Clone our starter project from Github
+
+```bash
+git clone https://github.com/medusajs/medusa-starter-default.git my-medusa-starter
+```
+
+2. Once cloned, we will jump into our project directory and get started with our configuration.
+
+```bash
+cd my-medusa-starter
+```
+
+3. Get your environment variables ready using our template
+
+```bash
+mv .env.template .env
+```
+
+4. Setup accounts for included plugins. This step is optional but required for placing orders.
+
+Create a Stripe account and add your API key and webhook secret to `.env`
+Create a SendGrid account and add your API key to `.env`
+
+```bash
+...
+STRIPE_API_KEY="some_stripe_key"
+STRIPE_WEBHOOK_SECRET="some_webhook_secret"
+SENDGRID_API_KEY="some_sendgrid_key"
+..
+```
+
+5. Start your server
+
+```bash
+docker-compose up --build
+```
+
+We will use docker-compose and Docker to start up our development environment. Running the above command will do the following:
+
+1. Build images for our Medusa project, a PostgreSQL database and a Redis server
+2. Run migrations for our newly created database
+3. Seed our database with some entities, that will allow us to easily get started.
+
+   These include:
+
+   - A user with email `admin@medusa-test.com` and password `supersecret`
+   - A region called Default Region with a small subset of countries
+   - A shipping option called Standard Shipping, that costs 10 EUR
+   - A product called Cool Test Product
+   - A variant of that product that costs 195 EUR
+
+Once done, our server will be accessible at `http://localhost:9000`.
+
+## Try it out
+
+Let's try out our Medusa server by fetching some products.
+
+```bash
+curl -X GET localhost:9000/store/products | python -m json.tool
+```
+
+## What's next?
+
+Add custom endpoint to your Medusa project (Insert link)
+
+Install and configure additional plugins (Insert link)
+
+Build a storefront using our Gatsby starter (Insert link)
@@ -0,0 +1,8 @@
+---
+templateKey: index-page
+pageTitle: Medusa docs
+introTtitle: Documentation
+introSubtitle: Explore and learn how to use Medusa.
+introDescriptionTitle: Quickstart
+introDescriptionSubtitle: Get up and running within 5 minutes, with helpful starters that lay the foundation for growth.
+---