strapi-pusher-notifications v0.0.1

Strapi-Pusher-Notification Plugin

Introduction

The Strapi Pusher Notification Plugin enables sending real-time notifications to users using Pusher within a Strapi application. By leveraging Pusher's Channels, this plugin facilitates the integration of instant notification features, enhancing user interaction with real-time updates.

Table of Contents

• Installation
  • Install the Plugin
  • Install Required Dependencies
  • Set Up Environment Variables
• Plugin Structure
• Creating a Pusher Notification Channel
• Usage
  • Sending Notifications
• Endpoints
• Example Code
  • Sending a Notification
  • Triggering a Pusher Event
• Additional Information
• Flow Diagram
• Video Demonstrations
• Conclusion

Installation

1. Install the Plugin

To install the plugin into your Strapi project, run the following command:

npm install strapi-pusher-notification

2. Install Required Dependencies

Ensure that you have the required dependencies installed:

npm install pusher

3. Set Up Environment Variables

Create a .env file in the root of your Strapi project and add the following Pusher configuration:

PUSHER_APP_ID= <your_app_id>
PUSHER_KEY= <your_app_key>
PUSHER_SECRET= <your_app_secret>
PUSHER_CLUSTER= <your_app_cluster>

Replace the placeholder values with your actual Pusher credentials. These variables are essential for authenticating and connecting to your Pusher Channels.

Plugin Structure

• strapi-pusher-notifications/admin/src/pages/homepage/index.js: Frontend component for sending notifications from the Strapi admin panel.
• strapi-pusher-notifications/server/controllers/pusher-notification.js: Handles the logic for sending notifications via Pusher.
• strapi-pusher-notifications/server/routes/index.js: Defines API routes for triggering notifications.

Creating a Pusher Notification Channel

Before sending notifications, you need to create a Pusher notification channel:

1. Sign up for a Pusher account and create a new Channels app via the Pusher Channels Dashboard.
2. Copy the App ID, Key, Secret, and Cluster from your Channels app and paste them into your .env file.
3. Configure your Channels app in the Pusher dashboard as needed, including setting up event triggers and channels.

Usage

Sending Notifications

With the plugin installed and your Pusher credentials set up, you can now send notifications:

1. Enter Your Notification Details:
   • Title: The main content of your notification.
   • Subtitle: Additional information or context.
   • Channel Name: The name of the Pusher channel to which you want to send the notification.
   • Event Name: The event name that triggers the notification on the specified channel.
2. Click "Send Notification": After entering the details, click the "Send Notification" button. The plugin will send the notification via Pusher to all connected users subscribed to the specified channel and event.

Endpoints

• POST /strapi-pusher-notifications/send-message: API endpoint to send a notification. This will trigger a Pusher event with the provided title, subtitle, channel, and event name.

Example Code

Sending a Notification

const sendNotification = async (title, subtitle, channel, event) => {
  try {
    await axios.post("/strapi-pusher-notifications/send-message", {
      title,
      subtitle,
      channel,
      event,
    });
    console.log("Notification sent successfully!");
  } catch (error) {
    console.error("Error sending notification:", error);
  }
};

Triggering a Pusher Event

const Pusher = require("pusher");

const pusher = new Pusher({
  appId: process.env.PUSHER_APP_ID,
  key: process.env.PUSHER_KEY,
  secret: process.env.PUSHER_SECRET,
  cluster: process.env.PUSHER_CLUSTER,
  useTLS: true,
});

pusher.trigger(channel, event, {
  title: title,
  subtitle: subtitle,
});

Additional Information

For more details on setting up Pusher and configuring your channels, refer to the official Pusher Channels Documentation.

Flow Diagram

Here is a visual representation of how notifications are sent using this plugin:

Video Demonstrations

• Pusher Integration with React Frontend

  • Description: Demonstrates how to integrate Pusher with a React frontend for real-time notifications.

• Strapi Admin Panel Integration

  • Description: Shows how to use the plugin in the Strapi admin panel to send notifications.

Conclusion

This plugin simplifies the process of sending real-time notifications in Strapi using Pusher. With just a few steps, you can integrate powerful notification features into your application. Happy coding!