README.md

Official Node.js News Feeder

Usage

This project is a proof of concept of a news feeder using NodeJS. It uses the Github API to fetch the relevant information from issues, releases..and then it generates a RSS feed with the latest news.

The RSS feed is available at https://raw.githubusercontent.com/nodejs/nodejs-news-feeder/main/feed.xml and https://nodejs.github.io/nodejs-news-feeder/feed.xml

In order to update the RSS feed, you need to trigger the Github Action Populate Feed manually or wait for the CRON job.

This process will generate a PR with the latest news, so we can change the content and decide when to merge it.

Development

git clone https://github.com/nodejs/nodejs-news-feeder
cd nodejs-news-feeder
nvm use
npm install

Scripts

Code linter

npm run lint
npm run lint:fix

Testing

npm run test
npm run test:watch
npm run test:coverage

RSS formatter

Update the feed.xml file format

npm run rss:format-check
npm run rss:format

RSS Build

Update the feed.xml file with the latest news

npm run rss:build

RSS Validate

Check the current feed.xml against the https://validator.w3.org/feed/check.cgi

npm run rss:validate

License

MIT License