From 09cc28e69c331605ee90794a6aba875d5ee627b1 Mon Sep 17 00:00:00 2001 From: George Mandis Date: Sun, 9 May 2021 14:56:56 -0400 Subject: [PATCH 1/5] Update README.md --- README.md | 50 ++++++++++++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 9bad979..794486e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,36 @@ # 🦉 Bubo Reader -Bubo Reader is a somewhat irrationally minimalist RSS and JSON feed reader you can deploy on [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 RSS and JSON feed reader you can deploy on [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 in my blog post '[Introducing Bubo RSS: An Absurdly Minimalist RSS Feed Reader](https://george.mand.is/2019/11/introducing-bubo-rss-an-absurdly-minimalist-rss-feed-reader/)' -## Getting Started +## Anatomy of Bubo Reader -How to deploy Bubo Reader in a few easy steps with Netlify or Glitch: +- `src/index.html` - a [Nunjucks](https://mozilla.github.io/nunjucks/) template that lets you change how the feeds are displayed +- `output/style.css` - a CSS file to stylize your feed output +- `src/feeds.json` - a JSON file containing the URLs for various site's feeds separated into categories +- `src/index.js` - the script that loads the feeds and does the actual parsinga and rendering -### Deploying to Glitch +## 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/) + +Not the most exciting-looking demos, I'll admit, but they work! + +**Getting Started** + +- [Deploying to Glitch](#glitch) +- [Deploying to Netlify](#netlify) +- [Keeping feeds updated](#updated) + + + +## Deploying to Glitch The quickest way is to remix the project on Glitch: [https://glitch.com/edit/#!/bubo-rss](https://glitch.com/edit/#!/bubo-rss) @@ -22,7 +42,8 @@ There is also a special `glitch` branch you can clone if you prefer: The only difference between this branch and `master` is that it spins up a server using [Express](https://expressjs.com/) to serve your `./output/index.html` file on Glitch. Everything else is the same. -### Deploying to Netlify + +## Deploying to Netlify - [Fork the repository](https://github.com/georgemandis/bubo-rss/fork) - From your forked repository go to and edcit `src/feeds.json` to manage your feeds and categories @@ -30,6 +51,7 @@ The only difference between this branch and `master` is that it spins up a serve 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! + ### Keeping Feeds Updated #### Using Netlify Webhooks @@ -52,22 +74,6 @@ How is the The GitHub Action-based approach different? The same build process ru The GitHub Action is setup to build and commit directly to the `master` branch, which is not the best practice. I'd suggest creating a separate branch to checkout and commit changes to in the Action. You could then specify that same branch as the one to checkout and publish on Netlify. -## Anatomy of Bubo Reader - -- `src/index.html` - a [Nunjucks](https://mozilla.github.io/nunjucks/) template that lets you change how the feeds are displayed -- `output/style.css` - a CSS file to stylize your feed output -- `src/feeds.json` - a JSON file containing the URLs for various site's feeds separated into categories -- `src/index.js` - the script that loads the feeds and does the actual parsinga and rendering - -## 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/) - -Not the most exciting-looking demos, I'll admit, but they work! - ## Support -If you found this useful please consider sponsoring me or this project. 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). \ No newline at end of file +If you found this useful please consider sponsoring me or this project. 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). From 967b9418629621eebb453ab26b8fbe0d20b572d2 Mon Sep 17 00:00:00 2001 From: George Mandis Date: Sun, 9 May 2021 15:20:35 -0400 Subject: [PATCH 2/5] Update FUNDING.yml --- .github/FUNDING.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index dd46b4d..5da78b6 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,7 +1,7 @@ # These are supported funding model platforms github: georgemandis -patreon: georgemandis +patreon: # open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel @@ -9,4 +9,4 @@ community_bridge: # Replace with a single Community Bridge project-name e.g., cl liberapay: # Replace with a single Liberapay username issuehunt: # Replace with a single IssueHunt username otechie: # Replace with a single Otechie username -custom: https://george.mand.is/sponsor +custom: # From 70f275ac3f26a17ad63edebd8d465b9588509437 Mon Sep 17 00:00:00 2001 From: George Mandis Date: Thu, 16 Sep 2021 10:50:26 -0700 Subject: [PATCH 3/5] Create LICENSE --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e1606d0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 George Mandis + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From cc489f3e860a71e9e6fff20e20920f885e325348 Mon Sep 17 00:00:00 2001 From: George Mandis Date: Thu, 16 Sep 2021 15:59:42 -0700 Subject: [PATCH 4/5] Update README.md Added showcase section --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 794486e..ed4e64c 100644 --- a/README.md +++ b/README.md @@ -77,3 +77,8 @@ The GitHub Action is setup to build and commit directly to the `master` branch, ## Support If you found this useful please consider sponsoring me or this project. 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)) From c94e07f727029ed4dd62b5c4aa723fb0a8343db4 Mon Sep 17 00:00:00 2001 From: George Mandis Date: Fri, 17 Sep 2021 15:57:44 -0700 Subject: [PATCH 5/5] Update README.md typo fixes --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ed4e64c..d4b688e 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ The only difference between this branch and `master` is that it spins up a serve ## Deploying to Netlify - [Fork the repository](https://github.com/georgemandis/bubo-rss/fork) -- From your forked repository go to and edcit `src/feeds.json` to manage your feeds and categories +- From your forked repository go to and edit `src/feeds.json` to manage your feeds and categories - [Create a new site](https://app.netlify.com/start) on Netlify from GitHub 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! @@ -66,13 +66,13 @@ If you already have a server running Linux and some command-line experience it m #### Using GitHub Actions -This approach is a little different and requires some modifications to the repository. Netlify started billing for [build minutes](https://www.netlify.com/pricing/faq/) very shortly after I published this project. Running `npm build` and downloading all of the RSS feeds took up a substantial number of this minutes, particulary if you had some kind of process pinging the webhook and trigger a build every 15 minutes or so. +This approach is a little different and requires some modifications to the repository. Netlify started billing for [build minutes](https://www.netlify.com/pricing/faq/) very shortly after I published this project. Running `npm build` and downloading all of the RSS feeds took up a substantial number of these, particulary if you had a process pinging the webhook and triggering a build every 15 minutes or so. -How is the The GitHub Action-based approach different? The same build process runs, but this time it's on GitHub's servers via the Action. It then **commits** the newly created file generated at `./output/index.html` back into the repository. Netlify still gets pinged when the repository is updated, but skips the `npm run build` step on their end, which significantly reduces the number of build minutes required. +How is the The GitHub Action-based approach different? The same build process runs, but this time it's on GitHub's servers via the Action. It then **commits** the newly created file generated at `./output/index.html` back into the repository. Netlify still gets pinged when the repository is updated, but skips the `npm run build` step on their end. This significantly reduces the number of build minutes required. -**Short Answer**: use the [`github-action-publishing`](https://github.com/georgemandis/bubo-rss/tree/github-action-publishing) branch for now if you'd prefer to use GitHub Actions to run your builds. +**TLDR**: use the [`github-action-publishing`](https://github.com/georgemandis/bubo-rss/tree/github-action-publishing) branch for now if you'd prefer to use GitHub Actions. -The GitHub Action is setup to build and commit directly to the `master` branch, which is not the best practice. I'd suggest creating a separate branch to checkout and commit changes to in the Action. You could then specify that same branch as the one to checkout and publish on Netlify. +**Note:** The GitHub Action is setup to build and commit directly to the `master` branch, which is not the best practice. I'd suggest creating a separate branch to checkout and commit changes to in the action. You could then specify that same branch as the one to checkout and publish on Netlify. ## Support