|
1 | | -# reflex |
| 1 | +# Reflex |
2 | 2 |
|
3 | 3 | Flutter plugin for notification read & reply. |
4 | 4 |
|
5 | | -## Getting Started |
| 5 | +<img src="https://i.imgur.com/462Y6wf.gif" title="Flutter_Shortcuts"/> |
6 | 6 |
|
7 | | -This project is a starting point for a Flutter |
8 | | -[plug-in package](https://flutter.dev/developing-packages/), |
9 | | -a specialized package that includes platform-specific implementation code for |
10 | | -Android and/or iOS. |
| 7 | +        |
11 | 8 |
|
12 | | -For help getting started with Flutter, view our |
13 | | -[online documentation](https://flutter.dev/docs), which offers tutorials, |
14 | | -samples, guidance on mobile development, and a full API reference. |
| 9 | +## Compatibility |
15 | 10 |
|
| 11 | +✅ Android </br> |
| 12 | +❌ iOS (active issue: [iOS support for reflex](https://github.com/DevsOnFlutter/reflex/issues/1)) |
| 13 | + |
| 14 | +## Show some :heart: and :star: the repo |
| 15 | + |
| 16 | +## Why use Reflex? |
| 17 | + |
| 18 | +Reflex Plugin is known for: |
| 19 | + |
| 20 | +| Reflex | |
| 21 | +| :--------------------------------- | |
| 22 | +| Fast, performant & compatible | |
| 23 | +| Free & Open-source | |
| 24 | +| Production ready | |
| 25 | +| Make App Reactive | |
| 26 | + |
| 27 | +## Features |
| 28 | + |
| 29 | +All the features listed below can be performed at the runtime. |
| 30 | + |
| 31 | +✅ Get Notification Stream </br> |
| 32 | +✅ Read Notification </br> |
| 33 | +✅ Reply From Notification </br> |
| 34 | +✅ Auto Reply </br> |
| 35 | + |
| 36 | +## Quick Start |
| 37 | + |
| 38 | +### Step 1: Include plugin to your project |
| 39 | + |
| 40 | +```yml |
| 41 | +dependencies: |
| 42 | + reflex: <latest version> |
| 43 | +``` |
| 44 | +
|
| 45 | +Run pub get and get packages. |
| 46 | +
|
| 47 | +### Step 2: Add Service in `AndroidManifest.xml` |
| 48 | + |
| 49 | +Add the following service inside the `application` tag of `AndroidManifest.xml`. |
| 50 | + |
| 51 | +```xml |
| 52 | + ... |
| 53 | + <service |
| 54 | + android:label="notifications" |
| 55 | + android:name="com.devsonflutter.reflex.notification.NotificationListener" |
| 56 | + android:permission="android.permission.BIND_NOTIFICATION_LISTENER_SERVICE"> |
| 57 | + <intent-filter> |
| 58 | + <action android:name="android.service.notification.NotificationListenerService" /> |
| 59 | + </intent-filter> |
| 60 | + </service> |
| 61 | +</application> |
| 62 | +``` |
| 63 | + |
| 64 | +### Step 3 |
| 65 | + |
| 66 | +## Project Created & Maintained By |
| 67 | + |
| 68 | +### Divyanshu Shekhar |
| 69 | + |
| 70 | +<a href="https://twitter.com/dshekhar17"><img src="https://github.com/aritraroy/social-icons/blob/master/twitter-icon.png?raw=true" width="60"></a> <a href="https://in.linkedin.com/in/dshekhar17"><img src="https://github.com/aritraroy/social-icons/blob/master/linkedin-icon.png?raw=true" width="60"></a> <a href="https://instagram.com/dshekhar17"><img src="https://github.com/aritraroy/social-icons/blob/master/instagram-icon.png?raw=true" width="60"></a> |
| 71 | + |
| 72 | +[](https://github.com/divshekhar/) |
| 73 | + |
| 74 | +### Subham Praharaj |
| 75 | + |
| 76 | +<a href="https://twitter.com/SubhamPraharaj6"><img src="https://github.com/aritraroy/social-icons/blob/master/twitter-icon.png?raw=true" width="60"></a> <a href="https://www.linkedin.com/in/subham-praharaj-66b172179/"><img src="https://github.com/aritraroy/social-icons/blob/master/linkedin-icon.png?raw=true" width="60"></a> <a href="https://instagram.com/the_champ_subham_865"><img src="https://github.com/aritraroy/social-icons/blob/master/instagram-icon.png?raw=true" width="60"></a> |
| 77 | + |
| 78 | +[](https://github.com/skpraharaj/) |
| 79 | + |
| 80 | +## Contributions |
| 81 | + |
| 82 | +Contributions are welcomed! |
| 83 | + |
| 84 | +**If you feel that a hook is missing, feel free to open a pull-request.** |
| 85 | + |
| 86 | +For a custom-hook to be merged, you will need to do the following: |
| 87 | + |
| 88 | +* Describe the use-case. |
| 89 | + |
| 90 | +* Open an issue explaining why we need this hook, how to use it, ... |
| 91 | + This is important as a hook will not get merged if the hook doens't appeal to |
| 92 | + a large number of people. |
| 93 | + |
| 94 | +* If your hook is rejected, don't worry! A rejection doesn't mean that it won't |
| 95 | + be merged later in the future if more people shows an interest in it. |
| 96 | + In the mean-time, feel free to publish your hook as a package on [https://pub.dev](https://pub.dev). |
| 97 | + |
| 98 | +* A hook will not be merged unles fully tested, to avoid breaking it inadvertendly in the future. |
| 99 | + |
| 100 | +## Stargazers |
| 101 | + |
| 102 | +[](https://github.com/DevsOnFlutter/reflex/stargazers) |
| 103 | + |
| 104 | +## Forkers |
| 105 | + |
| 106 | +[](https://github.com/DevsOnFlutter/reflex/network/members) |
| 107 | + |
| 108 | +## Copyright & License |
| 109 | + |
| 110 | +Code and documentation Copyright (c) 2021 [Divyanshu Shekhar](https://hackthedeveloper.com). Code released under the [BSD 3-Clause License](./LICENSE). |
0 commit comments