https://github.com/abertschi/flash-on-visit
Get visual feedback on your website traffic :flashlight:
https://github.com/abertschi/flash-on-visit
android macos nodejs
Last synced: about 2 months ago
JSON representation
Get visual feedback on your website traffic :flashlight:
- Host: GitHub
- URL: https://github.com/abertschi/flash-on-visit
- Owner: abertschi
- License: apache-2.0
- Created: 2017-01-01T18:29:03.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-07T17:18:08.000Z (about 8 years ago)
- Last Synced: 2025-02-01T09:22:56.091Z (4 months ago)
- Topics: android, macos, nodejs
- Language: CSS
- Homepage: http://flashonvisit.abertschi.ch/
- Size: 8.47 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/Apache-2.0)
[](http://twitter.com/andrinbertschi)
# flash-on-visit
> It's often the small things that matter most in life.
**flash-on-visit** gives you visual feedback on your website traffic by flashing the caps lock LED of your computer keyboard and notification light of your Android phone.
This app is in beta development :feet: Feedback appreciated!
## Android client
[Download the App from Google Play Store](https://play.google.com/store/apps/details?id=ch.abertschi.flashonvisit) 🔥
## MacOS client
The MacOS client is a Node.js app.
Check out [client_macos/README.md](client_macos/README.md) for installation instructions.
## Integrate on your website
Perform an HTTP GET request on `http://213.136.81.179:3004/channels/` where `` is an identifier for your website. The most straigth forward approach to achieve that is by using the script [client_browser/flash-on-visit.js](client_browser/flash-on-visit.js) as following:
```html
Your awesome website 🚀
fov.send('http://213.136.81.179:3004', 'abertschi');
```
This will notify clients listening for notifications in the set channel.
## Host your own backend
A current version of [server/server.js](server/server.js) is running on my server.
The backend is a Node.js app running `express` and `socket.io` and features a hook to notify Android clients
with Google's Firebase Cloud Messaging (FCM) Service.
In case you wanted to host your own server, you would have to setup a Firebase account and rebuild the Android client with your own credentials.
i.e. set these files:
- `./android/app/google-services.json` Credentials to receive Firebase Cloud Messaging notifications
- `./server/gcs_server_key.js`: API Key to send Firebase Cloud Messaging notifications
## Contributing
Help is always welcome. Contribute to the project by forking and submitting a pull request.
### Credits
Thanks to these amazing people:
* [KDB223](https://github.com/KDB223) with his work on [LEDControl](https://github.com/KDB223/LEDControl), Apache License Version 2.0
## Contact
Andrin Bertschi
www.abertschi.ch