Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/EFForg/pushserver
A server for sending push notifications to mobile apps
https://github.com/EFForg/pushserver
Last synced: 3 months ago
JSON representation
A server for sending push notifications to mobile apps
- Host: GitHub
- URL: https://github.com/EFForg/pushserver
- Owner: EFForg
- License: agpl-3.0
- Created: 2014-10-02T20:04:15.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-03-22T21:32:47.000Z (over 6 years ago)
- Last Synced: 2024-06-28T18:44:18.979Z (4 months ago)
- Language: JavaScript
- Size: 193 KB
- Stars: 30
- Watchers: 20
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
push server
============
[](https://travis-ci.org/EFForg/pushserver)
Hapi server app for creating and distributing push notifications
## Table of Contents
* [Getting Started](#getting-started)
* [Running the server](#running-the-server)
* [App Configuration](#app-configuration)
* [Securing the app](#securing-the-app)
* [Run tests](#run-tests)
* [API](#api)
* [Notifications](#notifications)
* [Subscriptions](#subscriptions)
* [Errors](#errors)
* [Angular App](#angular-app)
## Getting Started
```
npm install
bower install
gulp build
gulp syncDb
```
## Running the server
Start the hapi server and set up watches on templates, js and css
```
gulp watch
```
## App Configuration
App config is controlled via the [node-config](https://github.com/lorenwest/node-config) module.
To set push credentials, create a local.json file under the [config dir](/config) and override the CREDENTIALS setting.
Alternately, you can use:
* [Environment variables](https://github.com/lorenwest/node-config/wiki/Environment-Variables)
* [Command line options](https://github.com/lorenwest/node-config/wiki/Command-Line-Overrides)
## Securing the app
By default, the app exposes all API endpoints and the web UI. This would allow a 3rd party to send a correctly crafted notification object to the server and have it go to all subscribers.
You should ensure that wherever the app is running it either:
* has an authentication layer
* is running behind another server, nginx / apache etc., that restricts access to the relevant endpoints
## Run tests
```
gulp test
```
## API
### [Notifications](/routes/notifications)
- [**POST /api/1/notifications**](/routes/notifications/add_notification.js) - adds a new notification to the database and publishes it to all attached channels
- [**GET /api/1/notification/{notificationId}**](/routes/notifications/get_notification.js) - fetches the notification matching notificationId
- [**POST /api/1/notifications/search**](/routes/notifications/get_notifications.js) - fetches all notifications matching the supplied search object
See the [schema object](/routes/notifications/validation.js) for details of the object structure these endpoints accept
### [Subscriptions](/routes/subscriptions)
- [**POST /api/1/subscriptions**](/routes/subscriptions/add_subscription.js) - adds a new subscription and subscribes that user to notifications from their preferred channel(s)
- [**DELETE /api/1/subscriptions/{deviceId}**](/routes/subscriptions/delete_subscription.js) - deletes a subscription
See the [schema object](/routes/subscriptions/validation.js) for details of the object structure these endpoints accept
### [Errors](/routes/errors)
- [**POST /api/1/errors**](/routes/errors/log_error.js) - Logs a client-side error to the server logs
See the [schema object](/routes/errors/validation.js) for details of the object structure these endpoints accept
## Angular app
See the [www/README.md](/www/README.md) for details