/medusa-plugin-starter-ts

A plugin starter for medusa pre-configured and using typescript

Primary LanguageTypeScript

Medusa

Plugin starter (Typescript)

Start to write your own plugin as quick as possible

Awesome

Getting started

Installation

git clone git@github.com:adrien2p/medusa-plugin-starter-ts.git

Usage

Api

Admin routes

Those routes will automatically be attached by medusa to the admin path.

Store routes

Those routes will automatically be attached by medusa to the store path.

Custom routes

All those routes are added in the main router and you have to manage them.

Models/Migrations

Those models will be attach to the manager and included into the medusa container. The migrations will be applied automatically.

Subscribers

It acts like a service but its main purpose is to extends core flow depending on the events you want to listen to.

Services

Those services will be automatically added to the medusa container and will be available in any other service through the constructor injection.

Loaders

Those will be applied during the loading and allow you to register custom components to the container to be accessible later on.

Deployment

Once your plugin is done.

npm run build && npm version && npm publish

You can now install it into your project file medusa-config.