MusicThread Web Feeds

A light microservice to serve Atom 1.0 Feeds for MusicThread.

People use web feeds for following updates to specific threads via a feed reader/aggregator, or as part of automations with services like IFTTT. If you have a novel use for MusicThread Web Feeds, please let us know!

MusicThread Web Feeds are available at https://feed.musicthread.app/ but individuals may want to run their own fork with modifications.

URLs follow the same path structure as on the main website (i.e. /thread/<THREAD_KEY>). Private threads are not currently supported and attempting to access them will return an error.

Architecture

musicthread-webfeed is designed to be run using Cloudflare Workers.

The code is available in a single Javascript file (src/main.js) and should be trivially integrated into other environments if needed.

If you're interested in opening a PR to add or change features, please open an issue so we can discuss your plans first.

Local development

musicthread-webfeed requires node.js and npm, wrangler and a Cloudflare account.

An introduction to Cloudflare Workers is available here: "Get started guide".

To get set up locally:

1. Clone the latest release
2. In the project's root, run npm install to install all dependencies
3. Run npm run dev to run the local development server and watch the code for changes (the development service is available at http://localhost:8787)

Note: You may need to run npm run cf-login to sign into your Cloudflare account if this is your first time using Cloudflare Workers.

Deployment

Updates to the MusicThread hosted service are deployed manually, typically after merging into the main branch.

Deploying to your own Cloudflare account can be done by running npm run deploy, however additional setup may be needed. Please refer to Cloudflare's documentation for help.

If deploying to your own Cloudflare account, you should be aware of their request limits and pricing plans.