https://github.com/hkirat/notification-logger

Desktop notification for your console Logs
https://github.com/hkirat/notification-logger

Last synced: about 2 months ago
JSON representation

Desktop notification for your console Logs

• Host: GitHub
• URL: https://github.com/hkirat/notification-logger
• Owner: hkirat
• Created: 2016-10-12T11:53:30.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-21T18:40:14.000Z (4 months ago)
• Last Synced: 2024-07-27T08:05:21.264Z (about 2 months ago)
• Language: JavaScript
• Homepage: http://hkirat.github.io/notification-logger
• Size: 82 KB
• Stars: 1,014
• Watchers: 21
• Forks: 57
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Notification Logger [![npm version](https://badge.fury.io/js/notification-logger.svg)](https://badge.fury.io/js/notification-logger)

Ever wondered why you have to open the console every time you want to want to log a variable?

Notification Logger helps provide desktop notification for your console messages.

During development, You have to check the browser's inspector periodically to see what your console.log()'s are saying.

With [notification-logger](https://github.com/hkirat/notification-logger/), you can develop and debug web apps and see console messages as Desktop Notifications.

And it only adds ~50 lines to your project.

[Demo](http://singhharkirat.com/notification-logger)

Initial repo forked from [chinchang](https://github.com/chinchang)'s project [screenlog.js](https://github.com/chinchang/screenlog.js).

Check out his awesomeness over [here](https://kushagragour.in/)

## Screenshot

![notification-logger](./images/image.png)

## Installing

 - Use `npm` or `git clone` to download the module.

   - `npm install notification-logger`

   - `git clone https://github.com/hkirat/notification-logger.git`

 - include `notification-logger.js` or `notification-logger.min.js`

 - Initialise with `logger.init()`

## Methods

-----

* `logger.init` - Initialises the logger

* `logger.log` - Logs the message via a Desktop Notification only

* `console.log` - Logs the message via a Desktop Notification and in the browser console

* `logger.destroy` - Reverts console.log to original functionality

## Browser Support

Works best on latest versions of Google Chrome, Firefox and Safari.

## To Do

 - Add Custom Icon to Notifications

 - Unwrap Objects while Logging them as Desktop Notification

## Credits

 - Icons Made by [http://www.flaticon.com/authors/roundicons](roundicons).