https://github.com/rsc-labs/medusa-wishlist
Medusa Wishlist provides functionality which stores wishlist items in a list, which can be then shared with others.
https://github.com/rsc-labs/medusa-wishlist
medusa-plugin medusa-plugin-other medusajs medusajs-v2
Last synced: 12 days ago
JSON representation
Medusa Wishlist provides functionality which stores wishlist items in a list, which can be then shared with others.
- Host: GitHub
- URL: https://github.com/rsc-labs/medusa-wishlist
- Owner: RSC-Labs
- License: mit
- Created: 2025-01-10T15:22:44.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-26T18:15:52.000Z (about 2 months ago)
- Last Synced: 2025-03-26T12:37:53.883Z (about 1 month ago)
- Topics: medusa-plugin, medusa-plugin-other, medusajs, medusajs-v2
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Medusa Wishlist
## What is it?
Medusa Wishlist provides functionality which stores wishlist items in a list, which can be then shared with others.
## Installation
1. Install plugin by adding to your `package.json`:
```json
...
"@rsc-labs/medusa-wishlist": "0.0.3" // or other available version
...
```
and execute install, e.g. `yarn install`.
2. Add plugin to your `medusa-config.js`:
```js
...
plugins: [
{
resolve: "@rsc-labs/medusa-wishlist",
options: {}
}
]
...
```
or
```js
...
plugins: ["@rsc-labs/medusa-wishlist"]
...
```
### Database migration
Medusa Wishlist introduces new models in database. To have it working, you need to firstly execute migrations:
```bash
npx medusa db:migrate
```
### Copy the code
You can copy the code from /src into your Medusa project.
Add module to `medusa-config.js`:
```js
{
resolve: "./modules/wishlist",
}
```
Update your `package.json`:
```json
"dependencies": {
...
"jsonwebtoken": "^9.0.2"
}
```
### Database migration
Medusa Wishlist introduces new models in database. To have it working, you need to firstly execute migrations:
```bash
npx medusa db:migrate
```
## Overview
Everything is covered by the API definition - details are here: [Store API](./docs/api.yaml).
In short - every customer has wishlist entity created automatically when first item is being added.
Items can added, updated (e.g. by quantity) or deleted.
Wishlist can be shared by using token.
## Configuration
### Update JWT secret
Sharing functionality uses JWT to generate a token. To have it properly working, you shall set `jwtSecret` in options, e.g.:
```js
{
resolve: "@rsc-labs/medusa-wishlist",
options: {
jwtSecret: 'supersecret'
}
}
```