chore: reorganize docs apps (#7228)

* reorganize docs apps

* add README

* fix directory

* add condition for old docs
This commit is contained in:
Shahed Nasser authored and GitHub committed 2024-05-03 17:36:38 +03:00
1 parent 224ebb2154
commit 4fe28f5a95
6187 files changed
+601447 -598226

No files matched your search

@@ -0,0 +1,51 @@
export const metadata = {
title: `Local Event Bus Module`,
}
# {metadata.title}
The Local Event Bus Module uses Node EventEmitter to implement Medusa's pub/sub events system. The Node EventEmitter is limited to a single process environment.
This module is useful for development and testing, but it’s not recommended to be used in production.
For production, it’s recommended to use modules like [Redis Event Bus Module](../redis/page.mdx).
---
## Install the Local Event Bus Module
To install Local Event Bus Module, run the following command in the directory of your Medusa application:
```bash npm2yarn
npm install @medusajs/event-local
```
Next, add the module into the `modules` property of the exported object in `medusa-config.js`:
```js title="medusa-config.js"
module.exports = {
// ...
modules: {
// ...
eventBus: {
resolve: "@medusajs/event-local",
},
},
}
```
---
## Test the Module
To test the module, start the Medusa application:
```bash npm2yarn
npm run dev
```
You'll see the following message in the terminal's logs:
```bash noCopy noReport
Local Event Bus installed. This is not recommended for production.
```