From eadb76eefbd57e0bdae410dbdc834fe4d8c713b8 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Wed, 18 May 2022 18:08:22 +0300 Subject: [PATCH] chore(docs): Small modifications to quickstart guide (#1523) --- docs/content/quickstart/quick-start.md | 42 ++++++++++++++------------ 1 file changed, 22 insertions(+), 20 deletions(-) diff --git a/docs/content/quickstart/quick-start.md b/docs/content/quickstart/quick-start.md index f7022afb69..603bcdf765 100644 --- a/docs/content/quickstart/quick-start.md +++ b/docs/content/quickstart/quick-start.md @@ -1,6 +1,12 @@ # Quickstart -This quickstart is intended for experienced developers, that are accustomed with concepts like JavaScript, Node.js, SQL and the command line. For a more gentle introduction, see our tutorial on [how to set up your development environment](../tutorial/0-set-up-your-development-environment.md). +This document will guide you through setting up your Medusa server in a few minutes. + +:::tip + +For a more detailed guide on how to set up your local environment to work with Medusa, check out the documentation on [how to set up your development environment](/tutorial/set-up-your-development-environment). + +::: ## Prerequisites @@ -29,33 +35,29 @@ You can install Node from the [official website](https://nodejs.org/en/). 3. **Start your Medusa engine** ```bash + cd my-medusa-store medusa develop ``` -4. **Use the API** +After these 3 steps and in only a couple of minutes, you now have a complete commerce engine running locally. You can test it out by sending a request using a tool like Postman or through the command line: - ```bash - curl localhost:9000/store/products | python -m json.tool - ``` +```bash +curl localhost:9000/store/products | python -m json.tool +``` -After these four steps and only a couple of minutes, you now have a complete commerce engine running locally. You may now explore [the documentation](https://docs.medusajs.com/api) to learn how to interact with the Medusa API. You may also add [plugins](https://github.com/medusajs/medusa/tree/master/packages) to your Medusa store by specifying them in your `medusa-config.js` file. -We have a prebuilt Admin dashboard that you can use to configure and manage your store find it here: [Medusa Admin](https://github.com/medusajs/admin) +:::note -## What's next? +This command uses Python to format the result of the request better in your command line. If you don't want to use Python you can simply send a request without the formatting: -### Set up a storefront for your Medusa project - -We have created two starters for you that can help you lay a foundation for your storefront. The starters work with your new server with minimal configuration, simply clone the starters from here: - -- [Nextjs Starter](https://github.com/medusajs/nextjs-starter-medusa) -- [Gatsby Starter](https://github.com/medusajs/gatsby-starter-medusa) - -:::tip - -Medusa runs on port 9000 by default and the storefront starters are both configured to run on port 8000. If you wish to run your storefront starter on another port, you should update your CORS settings in your project's `medusa-config.js`. +```bash +curl localhost:9000/store/products +``` ::: - +- 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 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.