forked from notBrad/bubo-rss
Fixed merge conflict in README
This commit is contained in:
George Mandis
commit
c4aa99d086
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
@ -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: #
|
||||
|
||||
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -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.
|
||||
108
README.md
108
README.md
@ -1,61 +1,11 @@
|
||||
# 🦉 Bubo Reader
|
||||
|
||||
Bubo Reader is a borderline-irrationally minimalist <acronym title="Really Simple Syndication">RSS</acronym> and <acronym title="JavaScript Object Notation">JSON</acronym> feed reader you can deploy anywhere. Your own server, [Netlify](https://netlify.com) in a few steps or [Glitch](https://glitch.com) in even fewer steps! The goal of this project is to generate a page 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 <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.
|
||||
|
||||
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
|
||||
|
||||
Run `npm install` from the root of the folder. When the dependencies are finished installing run `npm run build`. The `output` folder will contain the final page build and can be opened right away.
|
||||
|
||||
## Deploying
|
||||
|
||||
How to deploy Bubo Reader in a few easy steps with Netlify or Glitch:
|
||||
|
||||
### 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)
|
||||
|
||||
Just changed some feeds in `./src/feeds.json` file and you're set! If you'd like to modify the style or the template you can changed `./output/style.css` file or the `./src/template.html` file respectively.
|
||||
|
||||
There is also a special `glitch` branch you can clone if you prefer:
|
||||
[https://github.com/georgemandis/bubo-rss/tree/glitch](https://github.com/georgemandis/bubo-rss/tree/glitch)
|
||||
|
||||
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
|
||||
|
||||
- [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
|
||||
- [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!
|
||||
|
||||
### Keeping Feeds Updated
|
||||
|
||||
#### Using Netlify Webhooks
|
||||
|
||||
To keep your feeds up to date you'll want to [setup a Build Hook](https://www.netlify.com/docs/webhooks/#incoming-webhooks) for your Netlify site and use another service to ping it every so often to trigger a rebuild. I'd suggest looking into:
|
||||
|
||||
- [IFTTT](https://ifttt.com/)
|
||||
- [Zapier](https://zapier.com/)
|
||||
- [EasyCron](https://www.easycron.com/)
|
||||
|
||||
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).
|
||||
|
||||
#### 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.
|
||||
|
||||
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.
|
||||
|
||||
**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.
|
||||
|
||||
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
|
||||
@ -72,6 +22,62 @@ You can view live demos here:
|
||||
|
||||
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)
|
||||
|
||||
<a id="glitch"></a>
|
||||
## 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)
|
||||
|
||||
Just changed some feeds in `./src/feeds.json` file and you're set! If you'd like to modify the style or the template you can changed `./output/style.css` file or the `./src/template.html` file respectively.
|
||||
|
||||
There is also a special `glitch` branch you can clone if you prefer:
|
||||
[https://github.com/georgemandis/bubo-rss/tree/glitch](https://github.com/georgemandis/bubo-rss/tree/glitch)
|
||||
|
||||
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.
|
||||
|
||||
<a id="netlify"></a>
|
||||
## Deploying to Netlify
|
||||
|
||||
- [Fork the repository](https://github.com/georgemandis/bubo-rss/fork)
|
||||
- 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!
|
||||
|
||||
<a id="updated"></a>
|
||||
### Keeping Feeds Updated
|
||||
|
||||
#### Using Netlify Webhooks
|
||||
|
||||
To keep your feeds up to date you'll want to [setup a Build Hook](https://www.netlify.com/docs/webhooks/#incoming-webhooks) for your Netlify site and use another service to ping it every so often to trigger a rebuild. I'd suggest looking into:
|
||||
|
||||
- [IFTTT](https://ifttt.com/)
|
||||
- [Zapier](https://zapier.com/)
|
||||
- [EasyCron](https://www.easycron.com/)
|
||||
|
||||
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).
|
||||
|
||||
#### 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 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. This significantly reduces the number of build minutes required.
|
||||
|
||||
**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.
|
||||
|
||||
**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
|
||||
|
||||
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))
|
||||
|
||||
Loading…
Reference in New Issue
Block a user