made dockerfile, etc

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.nvmrc

@@ -1 +1 @@
-16.4.1
+18.12.1

Dockerfile

@@ -0,0 +1,26 @@
+# Use an official Node.js runtime as a parent image
+FROM node:14
+
+# Set the working directory in the container
+WORKDIR /usr/src/app
+
+# Copy package.json and package-lock.json
+COPY package*.json ./
+
+# Install any dependencies
+RUN npm install
+
+# Bundle the source code inside the Docker container
+COPY . .
+
+# Build the project
+RUN npm run build:bubo
+
+# Install 'serve' to serve the static site
+RUN npm install -g serve
+
+# Make port 5000 available to the world outside this container
+EXPOSE 5000
+
+# Run 'serve' to serve the static site on port 5000
+CMD ["serve", "-s", "public", "-l", "5000"]

README.md

@@ -1,36 +1,28 @@
 [![Netlify Status](https://api.netlify.com/api/v1/badges/81dd219c-51cb-4418-a18c-42c8b104c689/deploy-status)](https://app.netlify.com/sites/bubo-rss-demo/deploys)
 
-# 🦉 Bubo Reader (2.0)
+# 🦉 Bubo Reader
 
-Bubo Reader is a hyper-minimalist <acronym title="Really Simple Syndication">RSS</acronym> and <acronym title="JavaScript Object Notation">JSON</acronym> feed reader you can deploy on your own server, [Netlify](https://netlify.com) in a few steps or [Glitch](https://glitch.com) in even fewer steps! The goal of the project is to generate a webpage that shows a list of links from a collection of feeds organized by category and website. That's it.
+Bubo Reader is a hyper-minimalist feed reader (RSS, Atom, JSON) you can deploy on your own server, [Netlify](https://netlify.com) in a few steps or [Glitch](https://glitch.com) in even fewer steps! The goal of the project is to generate a webpage that shows a list of links from a collection of feeds organized by category and website. That's it.
 
 It is named after this [silly robot owl](https://www.youtube.com/watch?v=MYSeCfo9-NI) from Clash of the Titans (1981).
 
-You can read more about how this project came about on my blog:  
+You can read more about this project on my blog:
+
 - [Introducing Bubo RSS: An Absurdly Minimalist RSS Feed Reader](https://george.mand.is/2019/11/introducing-bubo-rss-an-absurdly-minimalist-rss-feed-reader/).
+- [Publishing Bubos RSS to Netlify with GitHub Actions](https://george.mand.is/2020/02/publishing-bubos-rss-to-netlify-with-github-actions/)
 
+## Get Started
 
-## Getting Started
+- Clone or fork the repo and run `npm install` to install the dependencies.
-
-- Clone or fork the repo and run  `npm install` to install the dependencies.
 - Update `feeds.json` to include categories and links to feeds you would like to see.
 - Run `npm run build:bubo`
 
 That's it! You should now have a static page with links to the latest content from your feeds in the `public` folder, ready to serve.
 
-## Differences in Bubo 2.0
+<details>
-
+  <summary>
-Version 2.0 has introduced some substantial changes for Bubo! While the static output remains endearingly spartan, the engine that builds it has changed a bit.
+    <strong>Anatomy of Bubo Reader</strong>
-
+  </summary>
-Hopefully all of these changes are in services of making this project more useful to others and encouraging outside contributions.
-
-Changes of note:
-
-- Bubo has been rewritten in [TypeScript](https://www.typescriptlang.org/). It's pretty slick! I anticipate the typing could be improved, but it's a start.
-- You fill find an `.nvmrc` file in the root of this project. Learn more [about nvm](https://github.com/nvm-sh/nvm) if you're unfamiliar.
-- The script will actually write your `index.html` file for you (Previously the build script simply ran `node src/index.js > output/index.html`). It makes a strong assumption that this file lives in the `public` folder.
-- There is a somewhat sophisticated mechansim in-place for batching & throttling your requests, if needed.
-## Anatomy of Bubo Reader
 
 The static pieces:
 
@@ -45,14 +37,19 @@ The engine:
 - `src/renderer.ts` — The renderer that loads Nunjucks, the template and understands how to process the incoming feed data. Prefer something else? This is the place to change it!
 - `src/utilities.ts` — A variety of parsing and normalization utilities for Bubo, hidden away to try and keep things clean.
 
-## Throttling
+</details>
 
-In the main `index.ts` file you will find two values that allow yout to batch and throttle your feed requests:
+<details>
+  <summary>
+    <strong>Throttling</strong>
+  </summary>
 
-- `MAX_CONNECTIONS` dictates the maximium number of requests a batch can have going at once.
+In the main `index.ts` file you will find two values that allow you to batch and throttle your feed requests:
-- `DELAY_MS` dictates the amount of de;ay time between each batch.
 
-The default configuration is **no batching or throttling** beacuse `MAX_CONNECTIONS` is set to `Infinity`. If you wanted to change Bubo to only fetch one feed at a time every second you could set these values to:
+- `MAX_CONNECTIONS` dictates the maximum number of requests a batch can have going at once.
+- `DELAY_MS` dictates the amount of delay time between each batch.
+
+The default configuration is **no batching or throttling** because `MAX_CONNECTIONS` is set to `Infinity`. If you wanted to change Bubo to only fetch one feed at a time every second you could set these values to:
 
 ```javascript
 const MAX_CONNECTIONS = 1;
@@ -67,22 +64,20 @@ const DELAY_MS = 2500;
 ```
 
 In practice, I've never _really_ run into an issue leaving `MAX_CONNECTIONS` set to `Infinity` but this feels like a sensible safeguard to design.
-## Demos
 
-You can view live demos here:
+</details>
 
-- [https://bubo-rss-demo.netlify.com/](https://bubo-rss-demo.netlify.com/)
+<details>
-- [http://bubo-rss.glitch.me/](http://bubo-rss.glitch.me/)
+  <summary>
-
+    <strong>Getting Started</strong>
-Not the most exciting-looking demos, I'll admit, but they work!
+  </summary>
-
-**Getting Started**
 
 - [Deploying to Glitch](#glitch)
 - [Deploying to Netlify](#netlify)
 - [Keeping feeds updated](#updated)
 
 <a id="glitch"></a>
+
 ## Deploying to Glitch
 
 The quickest way is to remix the project on Glitch:
@@ -93,6 +88,7 @@ There is also a `glitch` branch on this repo if you'd prefer to start there.
 Just change some feeds in `./config/feeds.json` file and you're set! If you'd like to modify the style or the template you can changed `./public/style.css` file or the `./config/template.html` file respectively.
 
 <a id="netlify"></a>
+
 ## Deploying to Netlify
 
 - [Fork the repository](https://github.com/georgemandis/bubo-rss/fork)
@@ -102,6 +98,7 @@ Just change some feeds in `./config/feeds.json` file and you're set! If you'd li
 The deploy settings should automatically import from the `netlify.toml` file. All you'll need to do is confirm and you're ready to go!
 
 <a id="updated"></a>
+
 ### Keeping Feeds Updated
 
 #### Using Netlify Webhooks
@@ -112,21 +109,29 @@ To keep your feeds up to date you'll want to [setup a Build Hook](https://www.ne
 - [Zapier](https://zapier.com/)
 - [EasyCron](https://www.easycron.com/)
 
-#### Using GitHub Actions
-
-Coming soon—there is an old branch that demonstrates this, but it needs to be revisisted in light of Bubo 2.0.
-
 #### Rolling Your Own
 
 If you already have a server running Linux and some command-line experience it might be simpler to setup a [cron job](https://en.wikipedia.org/wiki/Cron).
 
+</details>
+
+## Demos
+
+You can view live demos here:
+
+- [https://bubo-rss-demo.netlify.com/](https://bubo-rss-demo.netlify.com/)
+- [http://bubo-rss.glitch.me/](http://bubo-rss.glitch.me/)
+
 ## Support
 
-If you found this useful please consider sponsoring me or this project. 
+If you found this useful please consider [sponsoring me or this project](https://github.com/sponsors/georgemandis).
 
 If you'd rather run this on your own server please consider using one of these affiliate links to setup a micro instance on [Linode](https://www.linode.com/?r=8729957ab02b50a695dcea12a5ca55570979d8b9), [Digital Ocean](https://m.do.co/c/31f58d367777) or [Vultr](https://www.vultr.com/?ref=8403978).
 
 ## Showcase
 
 Here are some websites using Bubo Reader:
+
 - [Kevin Fiol](https://kevinfiol.com/reader/) ([repo](https://github.com/kevinfiol/reader))
+
+Please share if you would like to be featured!

config/feeds.json

@@ -1,11 +1,12 @@
 {
-  "Web Development": [
+  "Developer News": [
-    "https://hacks.mozilla.org/feed/",    
+    "https://hacks.mozilla.org/feed/",
     "https://web.dev/feed.xml",
     "https://v8.dev/blog.atom",
     "https://alistapart.com/main/feed/",
     "https://css-tricks.com/feed/",
-    "https://dev.to/feed"
+    "https://dev.to/feed",
+    "https://changelog.com/feed"
   ],
   "Blogs": [
     "https://george.mand.is/feed.xml",
@@ -17,6 +18,6 @@
     "https://github.com/georgemandis/konami-js/releases.atom",
     "https://github.com/georgemandis/konami-js/commits/main.atom",
     "https://github.com/javascriptforartists/cheer-me-up-and-sing-me-a-song/commits/master.atom",
-    "https://github.com/georgemandis/circuit-playground-midi-multi-tool/commits/master.atom"    
+    "https://github.com/georgemandis/circuit-playground-midi-multi-tool/commits/master.atom"
   ]
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bubo-reader",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "A simple but effective feed reader (RSS, JSON)",
   "homepage": "https://github.com/georgemandis/bubo-rss",
   "main": "src/index.js",
@@ -27,19 +27,19 @@
   },
   "license": "MIT",
   "dependencies": {
-    "chalk": "^5.0.0",
+    "chalk": "^5.2.0",
-    "node-fetch": "^3.1.0",
+    "node-fetch": "^3.3.1",
-    "nunjucks": "^3.2.0",
+    "nunjucks": "^3.2.4",
-    "rss-parser": "^3.6.3"
+    "rss-parser": "^3.13.0"
   },
   "devDependencies": {
-    "@types/node": "^16.11.10",
+    "@types/node": "^20.2.5",
-    "@types/nunjucks": "^3.2.0",
+    "@types/nunjucks": "^3.2.2",
-    "@types/xml2js": "^0.4.9",
+    "@types/xml2js": "^0.4.11",
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.4.0",
+    "@typescript-eslint/parser": "^5.59.8",
-    "eslint": "^8.3.0",
+    "eslint": "^8.42.0",
-    "tslib": "^2.3.1",
+    "tslib": "^2.5.3",
-    "typescript": "^4.5.2"
+    "typescript": "^5.1.3"
   }
-}
+}

src/index.ts

@@ -66,7 +66,11 @@ let completed = 0;
  * and we want to build the static output.
  */
 const finishBuild: () => void = async () => {
-  console.log("\nDone fetching everything!");
+  completed++;
+  // if this isn't the last feed, just return early
+  if (completed !== feedListLength) return;
+
+  process.stdout.write("\nDone fetching everything!\n");
 
   // generate the static HTML output from our template renderer
   const output = render({
@@ -77,10 +81,10 @@ const finishBuild: () => void = async () => {
 
   // write the output to public/index.html
   await writeFile("./public/index.html", output);
-  console.log(
+  process.stdout.write(
     `\nFinished writing to output:\n- ${feedListLength} feeds in ${benchmark(
       initTime
-    )}\n- ${errors.length} errors`
+    )}\n- ${errors.length} errors\n`
   );
 };
 
@@ -103,8 +107,7 @@ const processFeed =
   }) =>
     async (response: Response): Promise<void> => {
       const body = await parseFeed(response);
-      completed++;
+      //skip to the next one if this didn't work out
-      // skip to the next one if this didn't work out
       if (!body) return;
 
       try {
@@ -124,20 +127,19 @@ const processFeed =
         });
 
         contentFromAllFeeds[group].push(contents as object);
-        console.log(
+        process.stdout.write(
-          `${success("Successfully fetched:")} ${feed} - ${benchmark(startTime)}`
+          `${success("Successfully fetched:")} ${feed} - ${benchmark(startTime)}\n`
         );
       } catch (err) {
-        console.log(
+        process.stdout.write(
           `${error("Error processing:")} ${feed} - ${benchmark(
             startTime
-          )}\n${err}`
+          )}\n${err}\n`
         );
         errors.push(`Error processing: ${feed}\n\t${err}`);
       }
 
-      // if this is the last feed, go ahead and build the output
+      finishBuild();
-      completed === feedListLength && finishBuild();
     };
 
 // go through each group of feeds and process
@@ -150,15 +152,16 @@ const processFeeds = () => {
     for (const feed of feeds) {
       const startTime = Date.now();
       setTimeout(() => {
-        console.log(`Fetching: ${feed}...`);
+        process.stdout.write(`Fetching: ${feed}...\n`);
 
         fetch(feed)
           .then(processFeed({ group, feed, startTime }))
           .catch(err => {
-            console.log(
+            process.stdout.write(
-              error(`Error fetching ${feed} ${benchmark(startTime)}`)
+              error(`Error fetching ${feed} ${benchmark(startTime)}\n`)
             );
-            errors.push(`Error fetching ${feed} ${err.toString()}`);
+            errors.push(`Error fetching ${feed} ${err.toString()}\n`);
+            finishBuild();
           });
       }, (idx % (feedListLength / MAX_CONNECTIONS)) * DELAY_MS);
       idx++;
@@ -166,4 +169,4 @@ const processFeeds = () => {
   }
 };
 
-processFeeds();
+processFeeds();