https://github.com/hackgt/buzzer

A robust notification delivery service
https://github.com/hackgt/buzzer

email event-management georgia-tech hackathon hackgt notifications slack twitter

Last synced: about 1 month ago
JSON representation

A robust notification delivery service

• Host: GitHub
• URL: https://github.com/hackgt/buzzer
• Owner: HackGT
• License: mit
• Created: 2018-01-29T04:04:26.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-09T23:39:32.000Z (almost 2 years ago)
• Last Synced: 2024-04-13T08:50:17.943Z (9 months ago)
• Topics: email, event-management, georgia-tech, hackathon, hackgt, notifications, slack, twitter
• Language: TypeScript
• Homepage:
• Size: 3.67 MB
• Stars: 3
• Watchers: 8
• Forks: 0
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Buzzer

Buzzer is HackGT's notification system. It works on the basis of plugins, where each plugin represents a different platform that a notification can be sent on.

## Plugins

- Email

  - Send emails to recipients via SendGrid

- FCM

  - Send push notifications to mobile devices

- LiveSite

  - Send alerts to users on live site

- MapGT

  - Send popups to users on MapGT via web sockets

- Slack

  - Send announcements to slack channels via Beardell Bot or a user

- Twilio

  - Send text notifications to individual phone numbers or registration user groups

- Twitter

  - Post a tweet on HackGT Twitter

## Getting Started

1. `yarn install`

2. `yarn dev`

## How to Use

Buzzer works via GraphQL APIs and you can send messages via the GraphQL playground and view docs at `/graphiql`. The GraphQL endpoint is `/graphql`.

Additionally, all messages, whether successful or errored out, will be logged to a MongoDB collection with the appropriate config and message used alongside. You can view the logs via a GraphQL query.