A small Frappe module that displays custom alerts to specific recipients after login.
Apologies in advance for any problem or bug you face with this module. Please report any problem or bug you face so it can be fixed.
The list of people who deserves more than a simple "Thank You".
- Frappe >= v12.0.0
Do not forget to replace [sitename] with the name of your site in all commands.
- Go to bench directory
cd ~/frappe-bench
- Get plugin from Github
(Required only once)
bench get-app https://github.com/kid1194/frappe_alerts
- Build plugin
(Required only once)
bench build --app alerts
- Install plugin on a specific site
bench --site [sitename] install-app alerts
- Check the usage section
- Go to app directory
cd ~/frappe-bench/apps/alerts
- Get updates from Github
git pull
- Go to bench directory
cd ~/frappe-bench
- Build plugin
bench build --app alerts
- Update a specific site
bench --site [sitename] migrate
- (Optional) Restart bench
bench restart
- Go to bench directory
cd ~/frappe-bench
- Uninstall plugin from a specific site
bench --site [sitename] uninstall-app alerts
- Remove plugin from bench
bench remove-app alerts
- (Optional) Restart bench
bench restart
- Go to
Alert Type
then create a new type - Enter the type name
- Set the
Display Priority
if needed - To make alerts of this type close automatically:
- Set the
Display Timeout (Seconds)
or keep as0
to disable the automatic close - Fraction numbers can also be used, like
1.5
, to set a more specific timeout
- Set the
- To customize the alert sound:
- Select the
Display Sound
that you prefer - Select
Custom
option to be able to upload aCustom Display Sound
- Select
None
to disable theDisplay Sound
- Select the
- To customize the look of the alert:
- Change the
Background Color
,Border Color
,Title Color
andContent Color
- Click on
Preview
to see how the custom style will look
- Change the
- Go to
Alert
and create new entry - Select an
Alert Type
and change the alertTitle
, if needed - Set the
From Date
andUntil Date
to specify the alert duration - Enter and format the
Message
of alert - Set the
For Roles
and/or theFor Users
to specify the alert recipients - Check
Is Repeatable
to display the alert more than once, and set theNumber of Repeats
- After submitting the alert:
- The
Seen By
table will be visible and will include all the reached users and datetime of reach
- The
- In list view, check the total number of unique users the alert has
Reached
If you find bug in the plugin, please create a bug report and let us know about it.
This repository has been released under the MIT License.