Skip to content

Commit

Permalink
docs: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
adrien2p committed Mar 8, 2022
1 parent 9b7daf1 commit f87390b
Show file tree
Hide file tree
Showing 33 changed files with 139 additions and 125 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,9 +59,8 @@
# Table of contents

- [Getting started](#getting-started)
- [Full documentation including API](https://adrien2p.github.io/medusa-extender/#/)
- [Full documentation](https://adrien2p.github.io/medusa-extender/#/)
- [Features](#features)
- [Demo: Products scoped per store (Marketplace)](#demo-products-scoped-per-store-marketplace)
- Starters
- [Server](https://github.com/adrien2p/medusa-extender/tree/main/starters/server)
- [Plugin module](https://github.com/adrien2p/medusa-extender/tree/main/starters/plugin-module)
Expand All @@ -75,6 +74,8 @@
- [Decorators API](#decorators-api)
- [Internal modules (Optional)](#internal-modules-optional)
- [Monitoring](#monitoring)
- [Resources](#marketplace)
- [Marketplace](#marketplace)

# Getting started

Expand Down Expand Up @@ -139,10 +140,6 @@ npm i medusa-extender
> Using swagger stats you can access all the stats from the ui in your app or
> use the raw stats to show with grafana, elasticsearch or event kibana.
# Demo: Products scoped per store (Marketplace)

[![Video demo: scoped products per store](https://raw.githubusercontent.com/adrien2p/medusa-extender/assets/assets/readme/store_scoped_demo_thumbnail.png)](https://streamable.com/e/oel4vl)

# Usage

For the purpose of the examples that will follow in the next sections,
Expand Down Expand Up @@ -663,10 +660,20 @@ Now, run your app and go to /monitoring url to get access to your dashboard.

For more information on the configuration, you can have a look at the [documentation](https://swaggerstats.io/guide/conf.html#options)

## Demo: Monitoring
### Demo

[![Video demo: scoped products per store](https://raw.githubusercontent.com/adrien2p/medusa-extender/assets/assets/readme/monitoring-ss.png)](https://streamable.com/k3ivnk)

# Marketplace

If you want to build a marketplace, the extender is your friend.
To help you in that process, a series of article will soon come out and will be referenced here.

Resources:

- [Marketplace tutorial](https://github.com/shahednasser/medusa-marketplace-tutorial)
- [Marketplace Plugin](https://github.com/shahednasser/medusa-marketplace)

# Contribute :ballot_box:

Contributions are welcome! You can look at the contribution [guidelines](./CONTRIBUTING.md)
21 changes: 14 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,8 @@ medusa-extender / [Exports](modules.md)
# Table of contents

- [Getting started](#getting-started)
- [Full documentation including API](https://adrien2p.github.io/medusa-extender/#/)
- [Full documentation](https://adrien2p.github.io/medusa-extender/#/)
- [Features](#features)
- [Demo: Products scoped per store (Marketplace)](#demo-products-scoped-per-store-marketplace)
- Starters
- [Server](https://github.com/adrien2p/medusa-extender/tree/main/starters/server)
- [Plugin module](https://github.com/adrien2p/medusa-extender/tree/main/starters/plugin-module)
Expand All @@ -76,6 +75,8 @@ medusa-extender / [Exports](modules.md)
- [Decorators API](#decorators-api)
- [Internal modules (Optional)](#internal-modules-optional)
- [Monitoring](#monitoring)
- [Resources](#marketplace)
- [Marketplace](#marketplace)

# Getting started

Expand Down Expand Up @@ -140,10 +141,6 @@ npm i medusa-extender
> Using swagger stats you can access all the stats from the ui in your app or
> use the raw stats to show with grafana, elasticsearch or event kibana.
# Demo: Products scoped per store (Marketplace)

[![Video demo: scoped products per store](https://raw.githubusercontent.com/adrien2p/medusa-extender/assets/assets/readme/store_scoped_demo_thumbnail.png)](https://streamable.com/e/oel4vl)

# Usage

For the purpose of the examples that will follow in the next sections,
Expand Down Expand Up @@ -664,10 +661,20 @@ Now, run your app and go to /monitoring url to get access to your dashboard.

For more information on the configuration, you can have a look at the [documentation](https://swaggerstats.io/guide/conf.html#options)

## Demo: Monitoring
### Demo

[![Video demo: scoped products per store](https://raw.githubusercontent.com/adrien2p/medusa-extender/assets/assets/readme/monitoring-ss.png)](https://streamable.com/k3ivnk)

# Marketplace

If you want to build a marketplace, the extender is your friend.
To help you in that process, a series of article will soon come out and will be referenced here.

Resources:

- [Marketplace tutorial](https://github.com/shahednasser/medusa-marketplace-tutorial)
- [Marketplace Plugin](https://github.com/shahednasser/medusa-marketplace)

# Contribute :ballot_box:

Contributions are welcome! You can look at the contribution [guidelines](./CONTRIBUTING.md)
10 changes: 5 additions & 5 deletions docs/classes/Medusa.Medusa-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Load medusa and apply all components

#### Defined in

[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/Medusa.ts#L37)
[src/Medusa.ts:37](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/Medusa.ts#L37)

## Properties

Expand All @@ -47,7 +47,7 @@ Load medusa and apply all components

#### Defined in

[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/Medusa.ts#L30)
[src/Medusa.ts:30](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/Medusa.ts#L30)

___

Expand All @@ -57,7 +57,7 @@ ___

#### Defined in

[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/Medusa.ts#L31)
[src/Medusa.ts:31](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/Medusa.ts#L31)

## Methods

Expand All @@ -77,7 +77,7 @@ ___

#### Defined in

[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/Medusa.ts#L45)
[src/Medusa.ts:45](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/Medusa.ts#L45)

___

Expand All @@ -91,4 +91,4 @@ ___

#### Defined in

[src/Medusa.ts:83](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/Medusa.ts#L83)
[src/Medusa.ts:83](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/Medusa.ts#L83)
12 changes: 6 additions & 6 deletions docs/classes/core_event_emmiter.Internals.CustomEventEmmiter.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ EventEmitter.constructor

#### Defined in

[src/core/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/event-emmiter.ts#L21)
[src/core/event-emmiter.ts:21](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/event-emmiter.ts#L21)

## Properties

Expand All @@ -51,7 +51,7 @@ EventEmitter.constructor

#### Defined in

[src/core/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/event-emmiter.ts#L19)
[src/core/event-emmiter.ts:19](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/event-emmiter.ts#L19)

## Methods

Expand Down Expand Up @@ -80,7 +80,7 @@ Emit an asynchrone event entity based and wait for the result.

#### Defined in

[src/core/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/event-emmiter.ts#L80)
[src/core/event-emmiter.ts:80](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/event-emmiter.ts#L80)

___

Expand Down Expand Up @@ -110,7 +110,7 @@ Register a new event handler.

#### Defined in

[src/core/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/event-emmiter.ts#L31)
[src/core/event-emmiter.ts:31](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/event-emmiter.ts#L31)

___

Expand All @@ -132,7 +132,7 @@ Apply all event handlers hold by the `listenerDescriptor`.

#### Defined in

[src/core/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/event-emmiter.ts#L43)
[src/core/event-emmiter.ts:43](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/event-emmiter.ts#L43)

___

Expand All @@ -146,4 +146,4 @@ ___

#### Defined in

[src/core/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/event-emmiter.ts#L68)
[src/core/event-emmiter.ts:68](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/event-emmiter.ts#L68)
2 changes: 1 addition & 1 deletion docs/classes/core_metadata_reader.Internals.CustomMap.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ Map.get

#### Defined in

[src/core/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/metadata-reader.ts#L5)
[src/core/metadata-reader.ts:5](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/metadata-reader.ts#L5)
12 changes: 6 additions & 6 deletions docs/classes/core_utils.Utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Utilities helper methods.

#### Defined in

[src/core/utils.ts:13](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/utils.ts#L13)
[src/core/utils.ts:13](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/utils.ts#L13)

## Methods

Expand Down Expand Up @@ -69,7 +69,7 @@ Attach a new subscriber to a specific entities.

#### Defined in

[src/core/utils.ts:40](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/utils.ts#L40)
[src/core/utils.ts:40](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/utils.ts#L40)

___

Expand All @@ -86,7 +86,7 @@ Display the logs that has been registered during the build time.

#### Defined in

[src/core/utils.ts:90](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/utils.ts#L90)
[src/core/utils.ts:90](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/utils.ts#L90)

___

Expand All @@ -111,7 +111,7 @@ Prepare the log to be shown to be consistent everywhere.

#### Defined in

[src/core/utils.ts:64](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/utils.ts#L64)
[src/core/utils.ts:64](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/utils.ts#L64)

___

Expand All @@ -134,7 +134,7 @@ Prepare the logs the show all available routes on the app.

#### Defined in

[src/core/utils.ts:77](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/utils.ts#L77)
[src/core/utils.ts:77](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/utils.ts#L77)

___

Expand Down Expand Up @@ -164,4 +164,4 @@ Since it is not possible to use multiple extend, you can use that utilities to a

#### Defined in

[src/core/utils.ts:20](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/utils.ts#L20)
[src/core/utils.ts:20](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/utils.ts#L20)
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L42)
[src/decorators/onMedusaEntityEvent.decorator.ts:42](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L42)

## Properties

Expand All @@ -55,7 +55,7 @@

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L40)
[src/decorators/onMedusaEntityEvent.decorator.ts:40](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L40)

___

Expand All @@ -65,7 +65,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L39)
[src/decorators/onMedusaEntityEvent.decorator.ts:39](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L39)

## Accessors

Expand All @@ -79,7 +79,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L50)
[src/decorators/onMedusaEntityEvent.decorator.ts:50](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L50)

___

Expand All @@ -93,7 +93,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L46)
[src/decorators/onMedusaEntityEvent.decorator.ts:46](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L46)

## Methods

Expand All @@ -120,7 +120,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L70)
[src/decorators/onMedusaEntityEvent.decorator.ts:70](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L70)

___

Expand All @@ -146,7 +146,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L58)
[src/decorators/onMedusaEntityEvent.decorator.ts:58](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L58)

___

Expand All @@ -173,7 +173,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L84)
[src/decorators/onMedusaEntityEvent.decorator.ts:84](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L84)

___

Expand All @@ -199,7 +199,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L66)
[src/decorators/onMedusaEntityEvent.decorator.ts:66](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L66)

___

Expand All @@ -226,7 +226,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L77)
[src/decorators/onMedusaEntityEvent.decorator.ts:77](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L77)

___

Expand All @@ -252,7 +252,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L62)
[src/decorators/onMedusaEntityEvent.decorator.ts:62](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L62)

___

Expand Down Expand Up @@ -280,7 +280,7 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L91)
[src/decorators/onMedusaEntityEvent.decorator.ts:91](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L91)

___

Expand All @@ -300,4 +300,4 @@ ___

#### Defined in

[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
[src/decorators/onMedusaEntityEvent.decorator.ts:54](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/decorators/onMedusaEntityEvent.decorator.ts#L54)
2 changes: 1 addition & 1 deletion docs/interfaces/core_types.MedusaMiddleware.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,4 @@ Describe a custom middleware instance.

#### Defined in

[src/core/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/types.ts#L152)
[src/core/types.ts:152](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/types.ts#L152)
2 changes: 1 addition & 1 deletion docs/interfaces/core_types.Type.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,4 @@ Function.constructor

#### Defined in

[src/core/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/cc3c8f9/src/core/types.ts#L6)
[src/core/types.ts:6](https://github.com/adrien2p/medusa-extender/blob/9b7daf1/src/core/types.ts#L6)
Loading

0 comments on commit f87390b

Please sign in to comment.