https://github.com/imsun/gh-feed

Generate RSS feed from GitHub Issues
https://github.com/imsun/gh-feed

Last synced: 29 days ago
JSON representation

Generate RSS feed from GitHub Issues

• Host: GitHub
• URL: https://github.com/imsun/gh-feed
• Owner: imsun
• License: mit
• Created: 2016-11-22T06:38:09.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-04T12:26:54.000Z (about 6 years ago)
• Last Synced: 2024-08-03T23:26:56.806Z (4 months ago)
• Language: JavaScript
• Homepage: http://gh-feed.imsun.net
• Size: 22.5 KB
• Stars: 62
• Watchers: 6
• Forks: 15
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hacking-lists - imsun/gh-feed - Generate RSS feed from GitHub Issues (JavaScript)

README

        
gh-feed

=======

Generate RSS feed from GitHub Issues.

Check out [gh-feed.imsun.net](http://gh-feed.imsun.net)

[中文简介](http://imsun.net/posts/gh-feed)

## Why

Some engineers take GitHub Issues as blogs. It's easy to use, supporting Markdown, Git, code highlighting, comments, notifications, and lots of fancy features. But there isn't a feed address for it. So I write this project.

## Usage

1. Open project's issues page on GitHub.

1. Paste its URL to the input field on gh-feed's index page, or just replace `https://github.com` with `http://gh-feed.imsun.net`

1. Get your feed address.

To customize your feed, you can add filters on issues page.

## To Run

### 1. Set Your GitHub Token (optional)

By default gh-feed uses GitHub API, but rate of requests is [limited by GitHub](https://developer.github.com/v3/#rate-limiting).

> For requests using Basic Authentication or OAuth, you can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit allows you to make up to 60 requests per hour. Unauthenticated requests are associated with your IP address, and not the user making requests.

For higher rate, you need to create `config.js` as follows:

```

module.exports = {

    token: 'Your GitHub token'

}

```

You can use [personal access token](https://github.com/settings/tokens) or [register an application](https://github.com/settings/developers) and [generate a token](https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization) for it.

Once you runs out your requests, gh-feed will **load the full issues page** to generate feed, which costs much more than using GitHub API.

### 2. Run It

```

npm install && npm start

```

## License

MIT