vik-varna-alerts

Email and web notifications for planned repairs from ViK-Varna

MIT License

Stars
2

ViK Varna Alerts

Email and web notifications for planned repairs from ViK-Varna

About

ViK Varna (-) is the local water supplier for Varna region in Bulgaria. They post notifications about planned repairs on their website but it is not possible to subscribe to those notifications and receive them immediately - instead one should check their website frequently.

The code in this repository serves as a middleware between the website and the user - it sends hourly notifications on email which contain the latest news related to planned repairs and outages.

The way the code is structured allows for integration with any other website which has a dedicated page for this purpose.

Usage

In order to use this repository, one must clone it and adjust the repository secrets found under settings/secrets/actions in the repository and add their own configuration:

# The email address of the recipient of the notifications
EMAIL_TO="[email protected]"

# The email address of the sender of the notifications
EMAIL_FROM="[email protected]"

# The web address (URL) of the page that contains the notifications
ALERTS_PAGE="https://website.notifications/deep/link/"

# The subject in the email
EMAIL_SUBJECT="Planned outages and repairs"

# The CSS selector for the HTML element which contains the notifications
DATE_SELECTOR='.item-date-selector'

# The CSS selector for the HTML element which contains the notifications
ALERTS_SELECTOR=".alerts-selector"

# A CSS class name for a single notification element
CHILD_CLASSNAME='alert-item'

# API key for Brevo (formerly known as Sendinblue)
SENDINBLUE_API_KEY="abc-123"

Available ways to use the code in this repository

The code is deployed via Vercel and is running as serverless lambda functions which can be accessed here:

When forked and correctly set up, this repository creates a CRON job which sends an email at 0 (zero) o'clock each hour between 5:00 and 14:00 UTC.

One can adjust this by modifying the parameters in the action configuration

Visitor stats

Code stats

LICENSE

MIT



Badges
Extracted from project README
Github Build Send email Codacy Badge Codebeat Badge CodeFactor Badge DeepScan grade Analytics