https://github.com/adrien2p/medusa-plugin-starter-ts

A plugin starter for medusa pre-configured and using typescript
https://github.com/adrien2p/medusa-plugin-starter-ts

Last synced: 23 days ago
JSON representation

A plugin starter for medusa pre-configured and using typescript

• Host: GitHub
• URL: https://github.com/adrien2p/medusa-plugin-starter-ts
• Owner: adrien2p
• Created: 2022-01-05T23:08:05.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-02-10T12:44:36.000Z (over 2 years ago)
• Last Synced: 2024-06-03T02:03:46.832Z (25 days ago)
• Language: TypeScript
• Homepage:
• Size: 269 KB
• Stars: 22
• Watchers: 2
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Lists

• awesome-medusajs - Plugin starter (Typescript)

README

        



  


    

  

  
Plugin starter (Typescript)

  
Start to write your own plugin as quick as possible

    

  

      

  



# Getting started

Installation

```bash

git clone [email protected]: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. 

```bash

npm run build && npm version && npm publish

```

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