Files
medusa-store/docs/content/development/modules/overview.mdx
2023-04-03 13:50:59 +02:00

48 lines
2.3 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
description: 'Learn what Modules are and how can you use them during your custom development with Medusa.'
---
import DocCardList from '@theme/DocCardList';
import Icons from '@theme/Icon';
# Modules
In this document, youll learn what Modules are and how can you use them during your custom development with Medusa.
## Overview
Modules are self-contained, reusable pieces of code that encapsulate specific functionality or features within an ecommerce application. They foster separation of concerns, maintainability, and reusability by organizing code into smaller, independent units that can be easily managed, tested, and integrated with other modules.
Modules further increase Medusas extensibility. Commerce modules, such as the cart engine, can be extended or entirely replaced with your own custom logic. They can also run independently of the core Medusa package, allowing you to utilize the commerce module within a larger commerce ecosystem. For example, you can use the Order module as an Order Management System (OMS) without using Medusas core.
This also applies to core logic such as caching or events systems. You can use modules to integrate any logic or third-party service to handle this logic. This gives you greater flexibility in how you choose your tech stack.
Modules are created and loaded similarly to plugins. They can be loaded from a local project, or they can be installed and loaded from an NPM package. In the Medusa backend, theyre added as part of the configurations in `medusa-config.js` to use and load them within the backend.
---
## Custom Development
Developers can create their own modules and use them in their Medusa backend. They can also publish these modules to NPM to reuse them across Medusa backend or allow other developers to use them.
<DocCardList colSize={6} items={[
{
type: 'link',
href: '/development/modules/create',
label: 'Create a Module',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to create a module in Medusa.'
}
},
{
type: 'link',
href: '/development/modules/publish',
label: 'Publish Module',
customProps: {
icon: Icons['academic-cap-solid'],
description: 'Learn how to publish your module on NPM.'
}
},
]} />