https://github.com/benhid/ghostie
Notifies you when long-running commands complete
https://github.com/benhid/ghostie
nodejs notifications socket-io
Last synced: 2 months ago
JSON representation
Notifies you when long-running commands complete
- Host: GitHub
- URL: https://github.com/benhid/ghostie
- Owner: benhid
- License: mit
- Created: 2022-06-02T13:21:10.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T08:34:12.000Z (about 1 year ago)
- Last Synced: 2026-01-26T23:29:07.530Z (5 months ago)
- Topics: nodejs, notifications, socket-io
- Language: JavaScript
- Homepage: https://ghostie.link
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 👻.link
Use ghostie to receive desktop notifications when any command finishes.
Grab an url or use your own (valid UUID v4) to get started:
```console
$ echo $(curl -sL https://ghostie.link)
https://ghostie.link/...
```
## How it works
ghostie establish a WebSocket connection between the server and the client via [socket.io](https://socket.io).
Submitted notifications (POSTed) are broadcasted to all connected clients and persisted in the local database.
If the user granted permission, a desktop notification is displayed using the [Notification API](https://developer.mozilla.org/es/docs/Web/API/notification).
## Run locally
Clone the repository and run the following commands:
Using node:
```console
$ npm i
$ npm start
```
Using Docker:
```console
$ docker build -t benhid/ghostie .
$ docker run -p 3000:3000 benhid/ghostie
```
## License
This project is licensed under the MIT license. See the [LICENSE](LICENSE) file for more info.