https://github.com/damianmoore/skylark-server
Get notifications on your phone that are easily sent via HTTP requests
https://github.com/damianmoore/skylark-server
notification notification-android notification-api notification-app notification-center notification-server notification-service notifications
Last synced: about 1 month ago
JSON representation
Get notifications on your phone that are easily sent via HTTP requests
- Host: GitHub
- URL: https://github.com/damianmoore/skylark-server
- Owner: damianmoore
- License: agpl-3.0
- Created: 2017-07-05T22:50:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T05:46:01.000Z (almost 3 years ago)
- Last Synced: 2025-03-04T05:45:08.420Z (7 months ago)
- Topics: notification, notification-android, notification-api, notification-app, notification-center, notification-server, notification-service, notifications
- Language: Python
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Skylark
*Easily send notifications to your phone via HTTP*
## Running the server
### Docker
Docker compose is the quickest way to get the server up and running. This will launch the server on [http://localhost:8000](http://localhost:8000).
```shell
docker run -p 8000:80 damianmoore/skylark-server:latest
```
### Checkout Python
If you want to help contribute or just want to avoid Docker then you can clone the repo, make a virtual environment, install requirements and run the Django runserver. It will be listening on [http://localhost:8000](http://localhost:8000).
```shell
git clone https://github.com/damianmoore/skylark-server.git
pipenv install
pipenv shell
./manage.py runserver
```
## Download and register the app
The latest Android release is available to download from [Google Play Store](https://play.google.com/store/apps/details?id=uk.co.epixstudios.skylark).
You are welcome to clone and build the [Android app project](https://github.com/damianmoore/skylark-android) for yourself.
Once you have the app installed you will need to connect it to the address of an instance of the server you have running (see above).
Help would be much appreciated if you have iOS experience. We also aim to have a desktop, browser-based notification implementation.
## Sending notifications
Notification can be sent via HTTP POST or GET with data transported as JSON, POST data or URL encoding. Here are a couple of examples.
### Python (requests library)
```python
import requests
requests.post('http://localhost:8000/webhook/', params={
'title': 'Notification from Python',
'body': 'Sent with the requests library',
'color': '#3776ab',
'icon': 'https://www.python.org/static/opengraph-icon-200x200.png',
})
```
### cURL
```shell
curl -X POST \
-H "Content-Type: application/json" \
-d '{"title": "Notification from cURL", "body": "Hello, World!", "color": "#ff9500", "icon": "http://i.imgur.com/7Ih60Gu.png"}' \
http://localhost:8000/webhook/
```
