* docs: added manage reservations user guide (#4290) * docs: added manage reservations user guide * removed feature flag details * docs: added how-to for custom reservations (#4292) * docs: added how-to for custom reservations * eslint fixes * docs: added product module documentation (#4287) * docs: added product module documentation * added details about optional environment variables * small fixes * Remove reference link * added example usages * added link to sample project * address PR feedback * docs: moved product module guide + added product module tabs (#4307) * added product module tab * adjust design of badge * docs: added onboarding features (#4168) * added marketplace page * added subscription roadmap * added rating for onboarding * added learning path components * small fixes * fix build error * fix eslint errors * change roadmaps to recipes * small change in text * optimize learning path and notifications * fix tracking usage * fix eslint errors * added enter/exit animation * allow starting a path using a query parameter * fix gap between notifications * address vercel comments * fixed links issue * changed create-medusa-app docs steps * move troubleshooting section * improved tracking across docs * fix build errors * remove console * added a note about `boilerplate` option * added troubleshooting section for eagain * added invite option in cli reference * added track event for finished onboarding * update boilerplate option name * redesigned learning path component * docs: added how to create widget docs (#4318) * docs: added how to create widget docs * remove development guide * added types * docs: added details about createCustomAdminHooks (#4288) * docs: added details about createCustomAdminHooks * small improvement * added missing import * small changes * docs: added onboarding guide (#4320) * docs: added how to create widget docs * remove development guide * docs: added onboarding guide * added types * added recipes link * small adjustments * fixed eslint errors * styling fixes * change to singular product module * updated the what's new section * shorten down medusa react card * updated tailwind configurations * fix build error * fix newspaper icon * style fixes * change modal shadow * fix color of line numbers * fix code fade color * docs: updated admin documentations * eslint fixes * text changes * added a note about beta version * remove empty object argument * remove demo repo url * fix selection color for code headers * general fixes * fix eslint error * changed code theme * added preparation step * changes regarding beta version * Update docs/content/modules/products/serverless-module.md Co-authored-by: Riqwan Thamir <rmthamir@gmail.com> * Update docs/content/modules/products/serverless-module.md Co-authored-by: Riqwan Thamir <rmthamir@gmail.com> --------- Co-authored-by: Riqwan Thamir <rmthamir@gmail.com> Co-authored-by: Oliver Windall Juhl <59018053+olivermrbl@users.noreply.github.com>
211 lines
5.6 KiB
Plaintext
211 lines
5.6 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 powerful and customizable REST APIs.',
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/quickstart',
|
||
label: 'Admin Dashboard',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'An admin dashboard used along with the Medusa backend and commerce modules. Merchants can use it to 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/products/serverless-module',
|
||
label: 'Product Module',
|
||
customProps: {
|
||
icon: Icons['tag-solid'],
|
||
description: 'Learn about the new product module and how to use it in a serverless setup.',
|
||
badge: {
|
||
variant: 'orange',
|
||
children: 'Beta'
|
||
}
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/widgets',
|
||
label: 'Admin Widgets',
|
||
customProps: {
|
||
icon: Icons['component-solid'],
|
||
description: 'Learn how you can customize the admin dashboard with admin widgets.',
|
||
badge: {
|
||
variant: 'orange',
|
||
children: 'Beta'
|
||
}
|
||
}
|
||
},
|
||
{
|
||
type: 'link',
|
||
href: '/admin/routes',
|
||
label: 'Admin UI Routes',
|
||
customProps: {
|
||
icon: Icons['computer-desktop-solid'],
|
||
description: 'Learn how you can customize the admin dashboard with admin UI routes.',
|
||
badge: {
|
||
variant: 'orange',
|
||
children: 'Beta'
|
||
}
|
||
}
|
||
},
|
||
]} />
|
||
|
||
<!-- 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.
|