Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kid1194/frappe_alerts
Frappe module that displays custom alerts to specific recipients after login.
https://github.com/kid1194/frappe_alerts
alerts alerts-manager erpnext erpnext-application erpnext-customization frappe frappe-erpnext frappe-framework
Last synced: about 1 month ago
JSON representation
Frappe module that displays custom alerts to specific recipients after login.
- Host: GitHub
- URL: https://github.com/kid1194/frappe_alerts
- Owner: kid1194
- License: other
- Created: 2022-11-27T18:43:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-04T20:24:14.000Z (about 1 month ago)
- Last Synced: 2024-05-04T21:27:22.973Z (about 1 month ago)
- Topics: alerts, alerts-manager, erpnext, erpnext-application, erpnext-customization, frappe, frappe-erpnext, frappe-framework
- Language: JavaScript
- Homepage:
- Size: 281 KB
- Stars: 21
- Watchers: 3
- Forks: 29
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-frappe - Alerts - Displays custom alerts to specific recipients after login. (Uncategorized / Uncategorized)
README
# Frappe Alerts
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.**
---
---
### Contributors
**The list of people who deserves more than a simple "Thank You".**
- [](https://github.com/git-avc)
- [](https://github.com/lan9635)
- [](https://github.com/satishkakani)
- [](https://github.com/neomrx)
---
### Table of Contents
- [Requirements](#requirements)
- [Setup](#setup)
- [Install](#install)
- [Update](#update)
- [Uninstall](#uninstall)
- [Usage](#usage)
- [Issues](#issues)
- [License](#license)
---
### 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
```
2. Get plugin from Github
*(Required only once)*
```
bench get-app https://github.com/kid1194/frappe_alerts
```
3. Build plugin
*(Required only once)*
```
bench build --app alerts
```
4. Install plugin on a specific site
```
bench --site [sitename] install-app alerts
```
5. Check the [usage](#usage) section
#### Update
1. Go to app directory
```
cd ~/frappe-bench/apps/alerts
```
2. Get updates from Github
```
git pull
```
3. Go to bench directory
```
cd ~/frappe-bench
```
4. Build plugin
```
bench build --app alerts
```
5. Update a specific site
```
bench --site [sitename] migrate
```
6. (Optional) Restart bench
```
bench restart
```
#### Uninstall
1. Go to bench directory
```
cd ~/frappe-bench
```
2. Uninstall plugin from a specific site
```
bench --site [sitename] uninstall-app alerts
```
3. Remove plugin from bench
```
bench remove-app alerts
```
4. (Optional) Restart bench
```
bench restart
```
---
### Usage
### Alert Type
- 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 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` for both, **Light** and **Dark** themes
- 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](https://github.com/kid1194/frappe_alerts/issues/new?assignees=kid1194&labels=bug&template=bug_report.md&title=%5BBUG%5D) and let us know about it.
---
### License
This repository has been released under the [MIT License](https://github.com/kid1194/frappe_alerts/blob/main/LICENSE).