https://github.com/jakeoeding/event-notifier
Get daily updates about local events
https://github.com/jakeoeding/event-notifier
docker pushover-notifications ruby
Last synced: about 2 months ago
JSON representation
Get daily updates about local events
- Host: GitHub
- URL: https://github.com/jakeoeding/event-notifier
- Owner: jakeoeding
- Created: 2024-12-26T17:21:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-18T21:36:45.000Z (about 1 year ago)
- Last Synced: 2025-07-01T15:14:13.922Z (about 1 year ago)
- Topics: docker, pushover-notifications, ruby
- Language: Ruby
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# event-notifier
## Motivation
Living near an event center has some perks, such as being able to walk to concerts and sporting events and not having to pay for parking. It also has some drawbacks, mainly, excessive extra traffic on days of events.
Enter `event-notifier`. This project aims to send a daily notification with the local events and their starting times each morning. This allows one to plan ahead and mitigate the effects of the extra traffic.
## Overview
This project works by requesting the event data from the event center's website. It uses a service called [Pushover](https://pushover.net/) to send push notifications with the daily event schedule. The daily job is scheduled via Github Actions.
## Dependencies
This project has the following dependencies to run locally:
- Docker
- docker compose
- A Pushover account
## Setup
Copy the override example file.
```bash
cp docker-compose.override.yml.example docker-compose.override.yml
```
Update the `PUSHOVER_USER_KEY` and `PUSHOVER_API_TOKEN` environment variables accordingly.
Build the project
```bash
docker compose build
```
## Usage
Executing the program locally is as simple as:
```bash
docker compose run --rm app
```