198 lines
5.5 KiB
Plaintext
198 lines
5.5 KiB
Plaintext
---
|
||
id: homepage
|
||
title: Medusa Documentation
|
||
description: "Medusa is an open source composable commerce platform. Learn about its features and how to use it."
|
||
slug: /
|
||
hide_table_of_contents: true
|
||
hide_footer: true
|
||
---
|
||
|
||
import DocCardList from '@theme/DocCardList';
|
||
import DocCard from '@theme/DocCard';
|
||
import Icons from '@theme/Icon';
|
||
|
||
# Medusa Documentation
|
||
|
||
Medusa is a set of commerce tools and modules that can be used to build unique commerce experiences.
|
||
|
||
Medusa provides the essential building blocks that developers can put together to create a powerful commerce store. Developers have full control over their tech stack and the logic behind the commerce features.
|
||
|
||
<DocCard item={{
|
||
type: 'link',
|
||
href: '/create-medusa-app',
|
||
label: 'Get Started',
|
||
customProps: {
|
||
icon: Icons['bolt-solid'],
|
||
html: 'Create a full-fledged Medusa project with one command.',
|
||
className: 'card-highlighted'
|
||
}
|
||
}} />
|
||
|
||
## Explore Medusa
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/overview',
|
||
label: 'Commerce Modules',
|
||
customProps: {
|
||
icon: Icons['puzzle-solid'],
|
||
description: 'Learn about the available ecommerce features and how to use and customize them.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/development/overview',
|
||
label: 'Medusa Development',
|
||
customProps: {
|
||
icon: Icons['server-stack-solid'],
|
||
description: 'Learn how to develop customized digital commerce applications with Medusa.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/user-guide',
|
||
label: 'User Guide',
|
||
customProps: {
|
||
icon: Icons['users-solid'],
|
||
description: 'No-code guides to help users manage their ecommerce stores using the Medusa admin.'
|
||
}
|
||
}
|
||
]} />
|
||
|
||
## Medusa Toolkit
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/development/backend/install',
|
||
label: 'Medusa Backend',
|
||
customProps: {
|
||
icon: Icons['circle-stack-solid'],
|
||
html: 'A Medusa Backend is any Node.js project with @medusajs/medusa installed. The core Medusa package orchestrates Medusa\'s Commerce Modules to expose a powerful and customizable REST API.',
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/quickstart',
|
||
label: 'Medusa Admin Quickstart',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'The Medusa admin is an intuitive admin dashboard that can be used along with the Medusa backend and modules. Merchants can use it to perform data management and processes such as manage orders, products, customers, and much more.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/js-client/overview',
|
||
label: 'JavaScript Client',
|
||
customProps: {
|
||
icon: Icons['javascript'],
|
||
description: 'Interact with a Medusa backend from a storefront or an admin built with any JavaScript framework.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/medusa-react/overview',
|
||
label: 'Medusa React',
|
||
customProps: {
|
||
icon: Icons['react'],
|
||
description: 'Interact with a Medusa backend from a React storefront or admin with utilities, hooks, and contexts.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/plugins/overview',
|
||
label: 'Plugins',
|
||
customProps: {
|
||
icon: Icons['squares-plus-solid'],
|
||
description: 'Supercharge your Medusa backend with plugins for Storage, Notifications, Analytics, and more.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/cli/reference',
|
||
label: 'Medusa CLI',
|
||
customProps: {
|
||
icon: Icons['command-line-solid'],
|
||
description: 'Use the Medusa CLI tool to execute commands on your Medusa backend.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/starters/nextjs-medusa-starter',
|
||
label: 'Next.js Storefront Quickstart',
|
||
customProps: {
|
||
icon: Icons['nextjs'],
|
||
description: 'Install the Next.js starter storefront and use it with the Medusa backend.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<DocCardList colSize={6} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/api/admin',
|
||
label: 'Admin API Reference',
|
||
customProps: {
|
||
icon: Icons['circle-stack-solid'],
|
||
description: 'Check out available REST APIs with example code snippets.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/api/admin',
|
||
label: 'Store API Reference',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'Check out available REST APIs with example code snippets.'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
## What's New
|
||
|
||
Learn about all the new features and enhancements in Medusa.
|
||
|
||
<DocCardList colSize={4} items={[
|
||
{
|
||
type: 'link',
|
||
href: '/modules/orders/admin/edit-order',
|
||
label: 'Edit an Order',
|
||
customProps: {
|
||
icon: Icons['pencil-square-solid'],
|
||
description: 'Gain more control over the order process by editing items in an order.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/modules/sales-channels',
|
||
label: 'Sales Channels',
|
||
customProps: {
|
||
icon: Icons['channels-solid'],
|
||
description: 'Expand your market and set configurations for different channels.'
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/development/publishable-api-keys',
|
||
label: 'Publishable API Keys',
|
||
customProps: {
|
||
icon: Icons['key-solid'],
|
||
description: 'Scope API calls to specific resources using an API key'
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<!-- vale docs.HeadingPunctuation = NO -->
|
||
|
||
## Need Help?
|
||
|
||
<!-- vale docs.HeadingPunctuation = YES -->
|
||
|
||
If you’re still not sure that Medusa is the right solution for you, you can get in-touch with the core Medusa team over at [Discord](https://discord.gg/medusajs) and get help from the community. |