2e16949979
* docs: update imports and package names across docs + reference configs * generate files * fix import * change preview to rc
109 lines
4.0 KiB
Plaintext
109 lines
4.0 KiB
Plaintext
import { CheckCircleSolid, BuildingStorefront, BuildingsSolid, ComputerDesktop, FlyingBox } from "@medusajs/icons"
|
||
import { config } from "@/config"
|
||
import { Prerequisites } from "docs-ui"
|
||
|
||
export const metadata = {
|
||
title: `${pageNumber} Introduction - ${config.titleSuffix}`,
|
||
}
|
||
|
||
# {pageNumber} Introduction
|
||
|
||
Medusa is a digital commerce platform with a built-in framework for customizations and integrations.
|
||
|
||
Medusa's framework includes two types of tools:
|
||
|
||
1. Modules that provide commerce functionalities, such as Product, Order, and Cart modules.
|
||
2. Customization tools to build your business features, such as custom data models, business logic, flows, and endpoints.
|
||
|
||
With these tools, you save time you would spend with other platforms on maintaining and setting up your customizations. Instead, you rapidly build important features for your business.
|
||
|
||
---
|
||
|
||
## Get started
|
||
|
||
<Prerequisites items={[
|
||
{
|
||
text: "Node.js v20+",
|
||
link: "https://nodejs.org/en/download"
|
||
},
|
||
{
|
||
text: "Git CLI tool",
|
||
link: "https://git-scm.com/downloads"
|
||
},
|
||
{
|
||
text: "PostgreSQL",
|
||
link: "https://www.postgresql.org/download/"
|
||
}
|
||
]} />
|
||
|
||
Create your first Medusa store by running the following command:
|
||
|
||
```bash
|
||
npx create-medusa-app@rc
|
||
```
|
||
|
||
---
|
||
|
||
## Who is Medusa for
|
||
|
||
Medusa is for ambitious businesses and developers that are limited by traditional ecommerce solutions:
|
||
|
||
- You want rich commerce features that are customizable and flexible enough to support your business use case as if you built them from scratch.
|
||
- You want your custom requirements built as an integral part of the commerce application’s features and architecture, rather than hacked into it.
|
||
- You want to customize your commerce flows by integrating external services without data inconsistency and irregularity.
|
||
|
||
<CardList items={[
|
||
{
|
||
title: "Use Case: D2C",
|
||
text: "How Matt Sleeps built a unique D2C experience with Medusa",
|
||
href: "https://medusajs.com/blog/matt-sleeps/",
|
||
icon: FlyingBox,
|
||
},
|
||
{
|
||
title: "Use Case: OMS",
|
||
text: "How Makro Pro Built an OMS with Medusa",
|
||
href: "https://medusajs.com/blog/makro-pro/",
|
||
icon: CheckCircleSolid,
|
||
},
|
||
{
|
||
title: "Use Case: Marketplace",
|
||
text: "How Foraged built a custom marketplace with Medusa",
|
||
href: "https://medusajs.com/blog/foraged/",
|
||
icon: BuildingStorefront,
|
||
},
|
||
{
|
||
title: "Use Case: POS",
|
||
text: "How Tekla built a global webshop and a POS system with Medusa",
|
||
href: "https://medusajs.com/blog/tekla-pos/",
|
||
icon: ComputerDesktop,
|
||
},
|
||
{
|
||
title: "Use Case: B2B",
|
||
text: "How Visionary built B2B commerce with Medusa",
|
||
href: "https://medusajs.com/blog/visionary/",
|
||
icon: BuildingsSolid,
|
||
},
|
||
{
|
||
title: "Use Case: Platform",
|
||
text: "How Catalog built a B2B platform for SMBs with Medusa",
|
||
href: "https://medusajs.com/blog/catalog/",
|
||
icon: BuildingsSolid,
|
||
}
|
||
]} itemsPerRow={2} />
|
||
|
||
---
|
||
|
||
## Who is this documentation for
|
||
|
||
This documentation is for TypeScript or JavaScript developers looking to master Medusa and build their commerce applications. By following this documentation, you’ll learn about Medusa’s concepts, from basic to advanced, with easy-to-follow examples to assist you along the way.
|
||
|
||
By the end of this documentation, you’ll be an expert Medusa developer, leading teams using Medusa from the development till production.
|
||
|
||
### How to use the documentation
|
||
|
||
The documentation for Medusa v2 is split into the following sections:
|
||
|
||
1. The main documentation, which is the one you're currently viewing. It's highly recommended to follow all the chapters in this documentation before jumping into other documentation sections.
|
||
2. The [Development Resources documentation](!resources!) provides guides and resources useful during your development, such as tools, API references, recipes, step-by-step guides and examples, and more.
|
||
3. The [Store](!api!/store) and [Admin](!api!/admin) API references provide a reference to the Medusa application's endpoints and instructions related to authentication, parameter types, and more.
|