From 8a4a7125b86776b9bc5f9c06b1bee594f64a6d73 Mon Sep 17 00:00:00 2001 From: Shahed Nasser Date: Fri, 17 Jun 2022 13:53:49 +0300 Subject: [PATCH] docs: updated homepage (#1687) --- docs/content/homepage.md | 81 ++++++++++++++++++++++++++++++++ docs/content/homepage.mdx | 97 --------------------------------------- 2 files changed, 81 insertions(+), 97 deletions(-) create mode 100644 docs/content/homepage.md delete mode 100644 docs/content/homepage.mdx diff --git a/docs/content/homepage.md b/docs/content/homepage.md new file mode 100644 index 0000000000..d103a31d89 --- /dev/null +++ b/docs/content/homepage.md @@ -0,0 +1,81 @@ +--- +id: homepage +title: Overview +description: 'What is Medusa?' +slug: / +hide_table_of_contents: true +--- + +Welcome to Medusa, the open source Shopify alternative! + +Medusa is an open-source headless commerce engine that enables developers to create amazing digital commerce experiences. + +:::tip + +Get started with Medusa in a few minutes with our [Quickstart guide](./quickstart/quick-start.md)! + +::: + +## Features + +Medusa comes with a set of building blocks that allow you to create unique digital commerce experiences, below is a list of some of the features that Medusa comes with out of the box: + +- **Headless**: Medusa is a highly customizable commerce API which means that you may use any presentation layer such as a website, app, chatbots, etc. +- **Regions** allow you to specify currencies, payment providers, shipping providers, tax rates, and more for one or more countries for truly international sales. +- **Orders** come with all the functionality necessary to perform powerful customer service operations with ease. +- **Carts** allow customers to collect products for purchase, add shipping details, and complete payments. +- **Products** come with relevant fields for customs, stock keeping, and sales. Medusa supports multiple options and unlimited variants. +- **Swaps** allow customers to exchange products after purchase (e.g. for incorrect sizes). Accounting, payment, and fulfillment plugins handle all the tedious work for you for automated customer service. +- **Claims** can be created if customers experience problems with one of their products. Plugins make sure to automate sending out replacements, handling refunds, and collecting valuable data for analysis. +- **Returns** allow customers to send back products and can be configured to function in 100% automated flow-through accounting and payment plugins. +- **Fulfillment API** makes it easy to integrate with any fulfillment provider by creating fulfillment plugins. +- **Payments API** makes it easy to integrate with any payment provider by creating payment plugins, we already support Stripe, Paypal, and Klarna. +- **Notification API** allows integrations with email providers, chatbots, Slack channels, etc. +- **Customer Login** gives customers a way of managing their data, viewing their orders, and saving payment details. +- **Shipping Options & Profiles** enable powerful rules for free shipping limits, multiple fulfillment methods, and more. +- **Medusa's Plugin Architecture** makes it intuitive and easy to manage your integrations, switch providers and grow with ease. +- **Customization** is supported for those special use cases that all the other e-commerce platforms can't accommodate. + +## Where to Get Started + +### The Medusa Server + +The first step is to [set up your development environment](tutorial/set-up-your-development-environment) with the requirements necessary to run a Medusa server. + +Then, you can follow our [quickstart guide](quickstart/quick-start.md) to install and run a Medusa server. + +### The Medusa Admin + +The Medusa Admin provides you with a lot of functionalities and configurations such as Product Management, Order Management, Discounts and Promotions, and more. + +You can install the Medusa admin in 2 steps by following our [Medusa Admin quickstart guide](admin/quickstart.md). + +### The Storefront + +The final step is to set up a storefront to sell your products. + +Medusa provides 2 starter storefronts, one built with [Next.js](./starters/nextjs-medusa-starter.md) and one with [Gatsby](./starters/gatsby-medusa-starter.md), that you can use to quickly set up your store and start selling. + +Alternatively, you can build your own storefront with any frontend framework of your choice just by connecting to your server with the [Storefront REST APIs](https://docs.medusajs.com/api/store/collection). + +## What’s Next 🚀 + +- 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). + +## Open Source Contribution + +As Medusa is an open source platform, contributions to improve it and its documentation are welcome. In the GitHub repository here’s where you’ll find the different components you can contribute to: + +- The core of the Medusa server resides in [`packages/medusa`](https://github.com/medusajs/medusa/tree/master/packages/medusa). +- You can also find all existing plugins under [the `packages` directory](https://github.com/medusajs/medusa/tree/master/packages). +- The documentation content resides in [`docs/content`](https://github.com/medusajs/medusa/tree/master/docs/content). The code for the documentation website is in [`www/docs`](https://github.com/medusajs/medusa/tree/master/www/docs). + +You can find more details about contributing in [CONTRIBUTING.md](https://github.com/medusajs/medusa/blob/master/CONTRIBUTING.md). + +## Community & Support + +If you need any support during your development with Medusa, you can join our [Discord Server](https://discord.gg/medusajs). You will get help directly from our core team as well as our community. + +By joining our Discord Server, you’ll also have the chance to participate in many events such as Bug Hunts and showcase your work with Medusa. \ No newline at end of file diff --git a/docs/content/homepage.mdx b/docs/content/homepage.mdx deleted file mode 100644 index 63a7c8740d..0000000000 --- a/docs/content/homepage.mdx +++ /dev/null @@ -1,97 +0,0 @@ ---- -id: homepage -title: Overview -description: 'What is Medusa?' -slug: / -hide_table_of_contents: true ---- - -import useBaseUrl from '@docusaurus/useBaseUrl' -import Link from '@docusaurus/Link' -import Tabs from '@theme/Tabs' -import TabItem from '@theme/TabItem' - -Medusa is an open-source Shopify alternative. - -It provides you with the primitives to create amazing digital commerce experiences. - -## Architecture overview - -Medusa is composed of 3 components: The headless backend, the admin dashboard, and the storefront. - -You can learn more about Medusa's architecture in [our introduction](/introduction). - -![Medusa's Architecture](https://i.imgur.com/ZHvM2bu.png) - -
-
-
- -
-

Tutorial

-

Set up your local development environment

-
- -
-
- -
-

Make it your own

-

Create custom endpoints, services, or subscribers.

-
- -
-
- -
-

Plugins

-

Add or build a plugin to make your engine more powerful.

-
- -
-
- -
-

Deploy in seconds

-

Use one of our guides to deploy your Medusa project in seconds.

-
- -
-
-
- -## Quickstart - -Visit our [Quickstart](https://github.com/medusajs/medusa#-quickstart) to get up and running in minutes with only a couple of commands. - -## What you'll find here - -
-
-
- -
-

Quickstart

-

A short guide to get you quickly started.

-
- -
-
- -
-

How-to and guides

-

Guides and walkthroughs of concepts, tools, deployment and APIs.

-
- -
- {/* Ref */} -
- -
-

Reference

-

Technical documentation of the Medusa API.

-
- -
-
-