https://github.com/surfstudio/flutter-push-notification

Made by Surf 🏄
https://github.com/surfstudio/flutter-push-notification

Last synced: 6 months ago
JSON representation

Made by Surf 🏄

• Host: GitHub
• URL: https://github.com/surfstudio/flutter-push-notification
• Owner: surfstudio
• License: apache-2.0
• Created: 2021-07-09T05:40:15.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-17T15:36:17.000Z (over 1 year ago)
• Last Synced: 2025-04-13T07:13:09.188Z (6 months ago)
• Language: Dart
• Homepage:
• Size: 235 KB
• Stars: 26
• Watchers: 8
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Push Notification





[![Build Status](https://shields.io/github/actions/workflow/status/surfstudio/flutter-push-notification/on_pull_request.yml?logo=github&logoColor=white)](https://github.com/surfstudio/flutter-push-notification)

[![Coverage Status](https://img.shields.io/codecov/c/github/surfstudio/flutter-push-notification?logo=codecov&logoColor=white)](https://app.codecov.io/gh/surfstudio/flutter-push-notification)

[![Pub Version](https://img.shields.io/pub/v/push_notification?logo=dart&logoColor=white)](https://pub.dev/packages/push_notification)

[![Pub Likes](https://badgen.net/pub/likes/push_notification)](https://pub.dev/packages/push_notification)

[![Pub popularity](https://badgen.net/pub/popularity/push_notification)](https://pub.dev/packages/push_notification/score)

![Flutter Platform](https://badgen.net/pub/flutter-platform/push_notification)

## Overview

Library for implementing push notifications.

The module contains the main work with push notifications.

## Example

An example of using the library can be found in [example](example).

* Create a notification data type through inheritance `NotificationPayload`.

* Create a strategy for handling notifications through inheritance `PushHandleStrategy`.

* Create a factory of strategies through inheritance `PushHandleStrategyFactory`.

* To receive notifications, you need to create an instance. `MessagingService`.

* To display notifications, you need to create an instance `NotificationController`.

* And pass created instances when creating `PushHandler` that will create the strategy using the factory.

## Installation

Add `push_notification` to your `pubspec.yaml` file:

```yaml

dependencies:

  push_notification: $currentVersion$

```

At this moment, the current version of push_notification is .


## Changelog

All notable changes to this project will be documented in [this file](./CHANGELOG.md).

## Issues

To report your issues, file directly in the [Issues](https://github.com/surfstudio/flutter-push-notification/issues) section.

## Contribute

If you would like to contribute to the package (e.g. by improving the documentation, fixing a bug or adding a cool new feature), please read our [contribution guide](./CONTRIBUTING.md) first and send us your pull request.

Your PRs are always welcome.

## How to reach us

Please feel free to ask any questions about this package. Join our community chat on Telegram. We speak English and Russian.

[![Telegram](https://img.shields.io/badge/chat-on%20Telegram-blue.svg)](https://t.me/SurfGear)

## License

[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)