https://github.com/tridz-dev/erpnext_fcm

Firebase Cloud Messaging integration for sending notification created in ERPNext/Frappe to users as push notification.
https://github.com/tridz-dev/erpnext_fcm

erpnext erpnext-application fcm firebase-cloud-messaging frappe frappe-framework push-notifications

Last synced: 4 months ago
JSON representation

Firebase Cloud Messaging integration for sending notification created in ERPNext/Frappe to users as push notification.

• Host: GitHub
• URL: https://github.com/tridz-dev/erpnext_fcm
• Owner: tridz-dev
• License: other
• Created: 2022-02-06T12:57:53.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-08-21T15:00:00.000Z (over 1 year ago)
• Last Synced: 2024-05-19T09:43:17.562Z (7 months ago)
• Topics: erpnext, erpnext-application, fcm, firebase-cloud-messaging, frappe, frappe-framework, push-notifications
• Language: Python
• Homepage:
• Size: 18.6 KB
• Stars: 23
• Watchers: 4
• Forks: 33
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: license.txt

Awesome Lists containing this project

• awesome-frappe - FCM Notification for ERPNext - Send notifications created in Frappe or ERPNext as push notication via Firebase Cloud Message. (Uncategorized / Uncategorized)

README

        
# FCM Notification for ERPNext

Send notifications created in Frappe or ERPNext as push notication via Firebase Cloud Message(FCM)

### Steps to use the app:

1. Install the app into your site. [(Refer)](https://frappeframework.com/docs/v13/user/en/bench/frappe-commands#app-installation)

2. Create a new Server Script with values given below


  i. Script Type: **DocType Event**


  ii. Reference Document Type: **Notification Log**


  iii. DocType Event: **Before Insert**


  iv. Script: `frappe.call("fcm_notification.send_notification.send_notification", doc=doc)`


To learn more about server scripts [see this link.](https://frappeframework.com/docs/v13/user/en/desk/scripting/server-script) 

2. Add your FCM server key in FCM Notification Settings. [(Refer)](https://intercom.help/push-monkey/en/articles/1649592-how-to-set-up-your-fcm-keys-previously-called-gcm)

3. Link your device id to each user using the **User Device** DocType.

4. Optionally create a notification in Frappe/ERPNext. [(Refer)](https://docs.erpnext.com/docs/v12/user/manual/en/setting-up/notifications)

5. Run an event that triggers any notification. The notifcation will be send the respetive user via FCM if they have subscribed to it.

## Supporting Organization

The development of this app was commissioned by [Searchosis marketing Pvt Ltd](searchosis.com)