Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oddbit/firebase-alerts
Firebase extension for sending Firebase Alerts to social platforms
https://github.com/oddbit/firebase-alerts
crashlytics discord-notifications firebase firebase-crashlytics firebase-extensions google-chat google-chat-notifications slack-notification slack-notifications slack-webhook
Last synced: 3 months ago
JSON representation
Firebase extension for sending Firebase Alerts to social platforms
- Host: GitHub
- URL: https://github.com/oddbit/firebase-alerts
- Owner: oddbit
- License: apache-2.0
- Created: 2022-10-23T11:58:53.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-02-22T06:54:54.000Z (11 months ago)
- Last Synced: 2024-07-30T18:52:25.055Z (6 months ago)
- Topics: crashlytics, discord-notifications, firebase, firebase-crashlytics, firebase-extensions, google-chat, google-chat-notifications, slack-notification, slack-notifications, slack-webhook
- Language: TypeScript
- Homepage: https://extensions.dev/extensions/oddbit/firebase-alerts
- Size: 1.51 MB
- Stars: 12
- Watchers: 8
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# About
Empower your team with timely Firebase notifications sent directly to your preferred communication platform.
## Key Features
- **Alerts:** Receive immediate notifications, enabling rapid debugging and issue resolution.
- **Flexible Webhook Support:** Easily integrates with popular platforms like:
- Slack
- Discord
- Google Chat
- **Extensible:** Readily build custom webhook plugins to connect with other notification channels.
- **Roadmap:** We're actively evolving to make the alerts and notifications more helpful. See our [roadmap](https://github.com/oddbit/firebase-alerts/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) for more info.
| Platform | App Distribution | Crashlytics | Performance |
| ----------- | :--------------: | :---------: | :---------: |
| Google Chat | ✅ | ✅ | ✅ |
| Slack | ✅ | ✅ | ✅ |
| Discord | ✅ | ✅ | ✅ |
| MS Teams | ❌ | ❌ | ❌ |
## Screenshots
| App Distribution | Crashlytics | Performance |
| :--------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: |
|  |  |  |
# Installation
Install the Firebase Alerts extension using the Firebase CLI or the Firebase console.
## Install using CLI
You can install this extension from source by forking the repository and run the
following command from your Firebase project root.
```bash
firebase ext:install oddbit/firebase-alerts
firebase deploy --only extensions
```
Read the [PREINSTALL](./PREINSTALL.md) and [POSTINSTALL](./POSTINSTALL.md) instructions
for further information and requirements.
# Getting involved
If you're reading this, you're awesome!
We welcome your contributions! If you'd like to suggest new features or platforms:
[Open an issue](https://github.com/oddbit/firebase-alerts/issues/new) on our GitHub repository
after searching to find if your idea or feedback has already been posted.
## Building webhook plugins
It's easy and fun to develop new webhook plugins. All you need to do is to
declare your new plugin and create a new class that extends the abstract
[`Webhook`](./functions/src/models/webhook.ts)
Have a look at the existing plugin(s) under [`functions/src/webhook-plugins/`](https://github.com/oddbit/firebase-alerts/tree/main/functions/src/webhook-plugins)
to see how an implementation can look like.
Create your new plugin alongside the existing plugins `your-new-plugin.ts`
```typescript
export class YourNewPluginWebhook extends Webhook {
// Implements Webhook
}
```
Registering the new plugin in the method [`webhookPluginFromUrl()`](https://github.com/oddbit/firebase-alerts/blob/main/functions/src/alerts/crashlytics.ts).