dethos
/
worker-planet
mirror of https://github.com/dethos/worker-planet.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Generate a single feed of content from multiple RSS/Atom sources. Runs on Cloudflare Workers.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
18 Commits
1 Branch
2 Tags
261 KiB
 
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Go to file
Gonçalo Valério c032bd06f6
bump version and fix headlines dialog 		2 months ago
.github/workflows enable codeql 2 years ago
templates bump version and fix headlines dialog 2 months ago
.gitignore Update wrangler (#1) 3 months ago
.prettierrc first commit. Generate project structure 2 years ago
CODE_OF_CONDUCT.md first commit. Generate project structure 2 years ago
LICENSE Add initial working version. 2 years ago
README.md Update instructions for using different templates 2 months ago
index.js add new example template 2 months ago
package-lock.json add new example template 2 months ago
package.json bump version and fix headlines dialog 2 months ago
webpack.config.js Update wrangler (#1) 3 months ago
wrangler.toml.example Update wrangler (#1) 3 months ago

README.md

Worker-planet

This project is meant to be an easy way to aggregate in a single page content from multiple sources. It takes a list of existing RSS feeds, aggregates their contents and displays them in chronological order.

It was inspired by other software packages such as Planet and MoonMoon but runs on top of Cloudflare Workers instead of being deployed on your own server.

This ends up being specially useful for communities, in order to follow the work being done and published by its members. Some examples of existing "planets" (but using different software):

Note: This project is still in its early days, so expect some rough edges. Any contributions are welcome.

How to deploy

  1. Clone this repository
  2. Install the project dependencies: npm install
  3. Create a wrangler.toml file based on the existing wrangler.toml.example
  4. Create KV namespaces and add their ids to the kv_namespaces setting on wrangler.toml
  5. Add your account_id and customize all the vars in wrangler.toml. FEEDS should be a string of coma separated urls, to each of the RSS/ATOM sources that will be part of your planet.
  6. Build the worker bundle: npm run build
  7. Deploy your new worker: npm run deploy

Note: For the last step you might need to set the CLOUDFLARE_API_TOKEN environment variable.

Configuration variables

  • FEEDS - list of sources used to fetch the planet's content (separate each url with a comma)
  • TITLE - Name of your planet (included in the generated html page and RSS feed)
  • DESCRIPTION - Free text to be included on the page (currently not used on the included template)
  • MAX_SIZE - Number of posts/entries that will be included on the page/feed
  • CACHE_MAX_AGE - To avoid hitting the KV store each time the content is fetched, the static content is cached. You should adjust this value to the frequency you pick for your cron. Defined in seconds (default: 3600)

Customize the generated HTML

Each community has its own identity, so you should be able to easily customize the look and feel of the generated page. To do so, before publishing you can edit one of the existing templates in the templates folder.

After, you should "precompile" that file using the following command:

$ npm run template -- templates/default.handlebars -f templates/default.precompiled.js

If the template name you are using is different from default, you should change the following 2 lines in index.js:

import template from './templates/default.precompiled'

let template = Handlebars.templates['default']