Skip to content

Latest commit

 

History

History
172 lines (123 loc) · 3.69 KB

README.md

File metadata and controls

172 lines (123 loc) · 3.69 KB
Raw

Frappe Alerts

A small Frappe module that displays custom alerts to specific recipients after login.

⚠️ This plugin is in ALPHA stage ⚠️

Alerts
Alerts
Alerts

Table of Contents

Requirements

  • Frappe >= v12.0.0

Setup

⚠️ Important ⚠️

Do not forget to replace [sitename] with the name of your site in all commands.

Install

  1. Go to bench directory
cd ~/frappe-bench
  1. Get plugin from Github

(Required only once)

bench get-app https://github.com/kid1194/frappe_alerts
  1. Build plugin

(Required only once)

bench build --app alerts
  1. Install plugin on a specific site
bench --site [sitename] install-app alerts
  1. Check the usage section

Update

  1. Go to app directory
cd ~/frappe-bench/apps/alerts
  1. Get updates from Github
git pull
  1. Go to bench directory
cd ~/frappe-bench
  1. Build plugin
bench build --app alerts
  1. Update a specific site
bench --site [sitename] migrate
  1. (Optional) Restart bench
bench restart

Uninstall

  1. Go to bench directory
cd ~/frappe-bench
  1. Uninstall plugin from a specific site
bench --site [sitename] uninstall-app alerts
  1. Remove plugin from bench
bench remove-app alerts
  1. (Optional) Restart bench
bench restart

Usage

Alert Type

  • Go to Alert Type then create a new type
  • Enter the title for the type
  • Set the Display Priority if needed
  • To make alerts of this type close automatically:
    • Set the Display Timeout (Seconds) or keep as 0 to disable the automatic close
    • Fraction numbers can also be used, like 1.5, to set a more specific timeout
  • To customize the alert sound:
    • Select the Display Sound that you prefer
    • Select Custom option to be able to upload a Custom Display Sound
    • Select None to disable the Display Sound
  • To customize the look of the alert:
    • Change the Background Color, Border Color, Title Color and Content Color
    • Click on Preview to see how the custom style will look

Alert

  • Go to Alert and create new entry
  • Select an Alert Type and change the alert Title, if needed
  • Set the From Date and Until Date to specify the alert duration
  • Enter and format the Message of alert
  • Set the For Roles and/or the For Users to specify the alert recipients
  • Check Is Repeatable to display the alert more than once, and set the Number of Repeats
  • After submitting the alert:
    • The Seen By table will be visible and will include all the reached users and datetime of reach
  • In list view, check the total number of unique users the alert has Reached

Issues

If you find bug in the plugin, please create a bug report and let us know about it.

License

This repository has been released under the MIT License.