Compatibility

This starter is compatible with versions >= 2.4.0 of @medusajs/medusa.

@tsc_tech/medusa-plugin-restock

This plugin that notifies customers when an out-of-stock item becomes available again. This helps businesses boost sales and improve customer satisfaction by keeping shoppers informed and engaged. The plugin supports automated alerts via email ensuring customers never miss out on their desired products. 🚀

Installation

To install the @tsc_tech/medusa-plugin-restock, run the following command:

npm install @tsc_tech/medusa-plugin-restock

or

yarn add @tsc_tech/medusa-plugin-restock

Configuration

Step 1: Update Medusa Configuration Modify your medusa-config.ts to include the restock plugin:

module.exports = defineConfig({
  plugins: [
    {
      resolve: "@tsc_tech/medusa-plugin-restock",
      options: {
        frontendUrl: process.env.FRONTEND_URL,
      },
    },
    ],
})

Environment Variables

FRONTEND_URL=http://localhost:8000 // your frontend url

Run migrations after installation

npx medusa db:migrate

NOTE: You must have one notification provider configured to send email.

Troubleshooting

If you encounter issues while setting up the plugin, consider the following:

Database Migration Issues: Run npx medusa db:migrate again and ensure your database is correctly set up.

Contribution

We welcome contributions to improve this plugin! If you have suggestions or find issues, feel free to submit a pull request or open an issue in the repository.