npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gfn

v1.0.0

Published

Cross-platform, native, desktop notification service for notifying when personal GitHub dashboard feed gets updated with new activity

Downloads

6

Readme

github-feed-notifier 🔔

Build Status Number of downloads Licence Number of dependencies Made with Love in India npm

:octocat::bell: Cross-platform, native, desktop notification service for notifying when personal GitHub dashboard feed gets updated with new activity

About

github-feed-notifier (GFN) is a small NodeJS program that produces desktop notifications when your GitHub dashboard feed is updated with a new item. The program uses node-notifier, which allows for cross-OS support (Linux, macOS and Windows).

Why

There are quite a few "feed notifiers" for GitHub, but most of them lack something that I want:

  • Cross-platform compatibilty
  • Configurability
  • Desktop notifications (and a not browser notification)
  • Easy installation

Usage

Installation

Requirements

Install GFN globally:

$ npm install -g gfn

and configure:

$ gfn config

Once properly configured, GFN can be run as a foreground process in your terminal: $ gfn or $ github-feed-notifier

Configuration

The main requirement for configuration is your personal GitHub feed URL. You can obtain it by following these steps:

  1. Login to GitHub and go to your dashboard (the homepage)
  2. Scroll down entirely, to the bottom of the feed (do not click the 'Load more' button)
  3. Click on the "Subscribe to your news feed" link

readme-subscribe-to-feed

  1. Copy the URL of this link. This is your personal feed URL
  2. Run gfn config and paste this link

Run as a Background Process

Though GFN can be run directly as shown above, it is meant to be run as a background process on your computer to prevent using an extra terminal session.

To start GFN as a background process, use forever, a simple CLI tool that allows a script to run forever, in the background.

To get started, install 'forever' globally:

$ npm install -g forever

Once installed, start forever:

$ forever start `npm root -g`/gfn

Start Automatically on System Startup

This is where it gets different for different platforms, OS's and builds. I recommend looking it up for your own platform.

One possible, cross-platform solution is to use pm2 instead of 'forever' to run the command forever, as pm2 lets you keep your process alive after every restart using startup hooks. But for a small project like this, pm2 might be overkill.

To get started, answers to questions on StackExchange worked for me, for Linux and macOS.


License

Copyright (c) Mihir Chaturvedi. All rights reserved.

Licensed under the MIT License.