https://github.com/strongloop/loopback-component-push
Push notification component for LoopBack.
https://github.com/strongloop/loopback-component-push
Last synced: 10 months ago
JSON representation
Push notification component for LoopBack.
- Host: GitHub
- URL: https://github.com/strongloop/loopback-component-push
- Owner: strongloop
- License: other
- Created: 2013-06-21T16:06:22.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-03-06T16:22:12.000Z (almost 6 years ago)
- Last Synced: 2024-05-09T23:41:58.050Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://loopback.io/doc/en/lb2/Push-notifications.html
- Size: 2.31 MB
- Stars: 96
- Watchers: 36
- Forks: 95
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# LoopBack Push Notification Component
**⚠️ LoopBack 3 is in Maintenance LTS mode, only critical bugs and critical
security fixes will be provided. (See
[Module Long Term Support Policy](#module-long-term-support-policy) below.)**
We urge all LoopBack 3 users to migrate their applications to LoopBack 4 as
soon as possible. Refer to our
[Migration Guide](https://loopback.io/doc/en/lb4/migration-overview.html)
for more information on how to upgrade.
## Overview
> StrongLoop Labs projects provide early access to advanced or experimental functionality. In general, these projects may lack usability, completeness, documentation, and robustness, and may be outdated.
However, StrongLoop supports these projects: Paying customers can open issues using the StrongLoop customer support system (Zendesk), and community users can report bugs on GitHub.
This module provides a set of LoopBack models to enable mobile device push notifications.
Please see the full documentation: [Push notifications](http://docs.strongloop.com/display/LB/Push+notifications).
> The loopback-component-push module supersedes [loopback-push-notification](https://www.npmjs.org/package/loopback-push-notification). Please update your package.json accordingly.
## Architecture
## Key Components
- Device model and APIs to manage devices with applications and users
- Application model to provide push settings for device types such as ios and
android
- Notification model to capture notification messages and persist scheduled
notifications
- Optional Job to take scheduled notification requests
- Push connector that interact with device registration records and push
providers such as APNS, GCM, and MPNS
- Push model to provide high level APIs for device-independent push notifications
## Samples
### Node.js server
This module includes an [example LoopBack server application](https://github.com/strongloop/loopback-example-push).
To run it, use these commands:
```shell
$ cd example/server
$ npm install
$ bower install
$ node app
```
Open your browser to [http://127.0.0.1:3010](http://127.0.0.1:3010).
By default, the application uses an in-memory store for the application/installation data.
To change to a MongoDB instance, set the MONGODB environment variable to the MongoDB URL. For example,
```shell
MONGODB=mongodb://localhost/demo node app
```
### iOS client
The [iOS example app](https://github.com/strongloop/loopback-example-push/tree/master/ios)
uses the LoopBack iOS SDK to enable and handle push notifications.
### Android client
The [Android example app](https://github.com/strongloop/loopback-example-push/tree/master/android)
uses the LoopBack Android SDK to enable and handle push notifications.
## References
- https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html
- http://developer.android.com/google/gcm/index.html
- http://msdn.microsoft.com/en-us/library/windowsphone/develop/hh202945(v=vs.105).aspx
- https://github.com/argon/node-apn
- https://github.com/logicalparadox/apnagent-ios
- https://blog.engineyard.com/2013/developing-ios-push-notifications-nodejs
## Module Long Term Support Policy
This module adopts the [
Module Long Term Support (LTS)](http://github.com/CloudNativeJS/ModuleLTS) policy,
with the following End Of Life (EOL) dates:
| Version | Status | Published | EOL |
| ------- | --------------- | --------- | -------- |
| 3.x | Maintenance LTS | Dec 2016 | Dec 2020 |
Learn more about our LTS plan in [docs](https://loopback.io/doc/en/contrib/Long-term-support.html).