Web Push Notifications in Ruby on Rails.


Push Notification 1	Push Notification 2

Introduction

This repository demonstrates how to integrate Web Push Notifications into a web application, enabling real-time updates and alerts for users. Push notifications are a powerful tool for enhancing user engagement and keeping users informed about important events or updates within your application.

Additional Resources

For more in-depth information and best practices on implementing Web Push Notifications in Ruby on Rails, check out our comprehensive article:

Web Push Notifications in Ruby on Rails - Best Practices

Prerequisites

Before implementing Web Push Notifications in your web application, make sure you have the following prerequisites in place:

Web Application: You should have an existing web application where you want to incorporate push notifications.
Service Worker: Create and configure a Service Worker in your application. A Service Worker is responsible for handling push notifications and background synchronization.
VAPID Keys: Generate VAPID (Voluntary Application Server Identification) keys for secure communication with push service providers. You'll need these keys to establish a secure connection between your server and push service providers.

To generate VAPID keys, you can use a tool or library like web-push. After generating the keys, store them securely in your environment variables or Rails credentials. Here's how you can set them up:
- Environment Variables:
```
DEFAULT_APPLICATION_SERVER_KEY=your_public_key_here
DEFAULT_EMAIL=your@email.com
DEFAULT_PRIVATE_KEY=your_private_key_here
```
- Rails Credentials:
  
  Store your VAPID keys securely using Rails credentials:
  1. Open your Rails credentials file:
```
rails credentials:edit
```
  2. Add the VAPID keys:
```
push_notifications:
  vapid_public_key: your_public_key_here
  vapid_email: your@email.com
  vapid_private_key: your_private_key_here
```
  3. Save and close the credentials file.
Be sure to keep these keys confidential to maintain the security of your push notification system.

Getting Started

Clone this repository to your local development environment:

Clone the repository:

git clone https://github.com/DeVuDeveloper/push-notifications.git
cd push-notifications

Install the required gems:

 bundle install
 bin/setup

Set up the database:

  rails db:create
  rails db:migrate
  rails db:seed

Run the server(Open your Browser and navigate to url: http://localhost:3000/):

  bin/dev

Linter

The Push Notifications App a linter. You can run the linter with the following command:

  rubocop && rubocop -A

Testsing

To ensure that your push notification system works correctly across different browsers and devices, follow these testing steps:

Install any required testing dependencies if you haven't already.
Execute the tests to verify that push notifications are delivered and displayed as expected.

  rspec spec
  npm test

Usage

Sending Push Notifications
- Use the provided controller (push-notifications-controller.rb) to send push notifications to your users programmatically. You can trigger notifications for various events, updates, or relevant information within your application.
- Customize the notification content, including the title, body, and icon, based on the context of your notifications.
Handling Push Events
- The Service Worker (service_worker.js) will handle incoming push events and display notifications to users, even when they are offline. Ensure your Service Worker logic is correctly configured to provide a seamless notification experience.

Built With 🔨

	Languages
	!

	Tools 🛠️

(back to top)

Authors ✍️

👤 DeVuDeveloper

| |