sam/fedifeed
Archived
1
0
Fork 1
Code Issues 3 Pull requests Projects Releases Wiki Activity
ActivityPub feed => iframe embed. https://blog.froth.zone/sam/the-end-of-an-era
This repository has been archived on 2023-05-27. You can view files and clone it, but cannot push or open issues or pull requests.
69 commits 7 branches 0 tags 3.5 MiB
CSS 56.3%
JavaScript 24.1%
EJS 11.4%
HTML 8.2%
Find a file
fenwick67 270391a6e8 log referer and URI encode redirects
2019-08-05 16:19:27 -04:00
lib make all links target top window 2019-08-02 18:33:33 -04:00
static make the default in the UI be hiding replies and hiding boosts. 2019-08-02 18:37:15 -04:00
stylesrc Make error pages prettier 2019-08-02 11:57:13 -04:00
test allow people to filter out replies and/or boosts 2018-03-24 13:01:26 -05:00
.gitignore make CWs work 2018-09-29 17:29:17 -05:00
build-styles.js big commit! fix styles and parsing. 2017-05-01 22:11:29 -05:00
index.js log referer and URI encode redirects 2019-08-05 16:19:27 -04:00
LICENSE Create LICENSE 2017-04-30 13:04:48 -05:00
npm-shrinkwrap.json improve logger 2019-08-02 13:24:31 -04:00
package.json improve logger 2019-08-02 13:24:31 -04:00
README.md document v2 API 2019-08-02 13:33:03 -04:00

README.md

Mastofeed

Embed a mastodon feed in your blog et cetera.

https://www.mastofeed.com

User guide

The homepage has a tool for generating iframe code for you, with a sensible sandbox attribute. The feeds fit comfortably in a 400px wide area.

API

V2

GET /apiv2/feed

example: /api/feed?userurl=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67&scale=90&theme=light

Returns a html page which displays a mastodon feed for a user URL. Note that URLs must be URI encoded (i.e. encodeURIComponent('https://octodon.social/users/fenwick67') ).

Querystring options:

option required description
userurl yes Mastodon/ActivityPub account URL (usually https://${instance}/users/${username})
feedurl no a URL to a page of an ActivityPub post collection. Only used for pages beyond the first.
theme no either dark or light, to select the UI theme (default is dark).
boosts no whether to show boosts or not
replies no whether to show replies or not
size no the scale of the UI in percent.

V1 (deprecated, will now just redirect you to the v2 API)

GET /api/feed

example: /api/feed?url=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67.atom&scale=90&theme=light

Returns a html page which displays a mastodon feed for an atom feed URL. Note that URLs must be URI encoded (i.e. encodeURIComponent('https://octodon.social/users/fenwick67.atom') ).

Querystring options:

option required description
url yes Mastodon Atom feed URL
theme no either dark or light, to select the UI theme (default is dark).
size no the scale of the UI in percent.

Server Installation

This is a straightforward node project with zero databases or anything, you should just be able to run npm install and then npm start to get up and running. Set your PORT environment variable to change the port it listens on.

Improve me

Feel free to add a chaching layer, improve the styles and add more features.