grumbulon/fedifeed
1
0
Fork 0
forked from sam/fedifeed
Code Issues Pull requests Projects Releases Wiki Activity
ActivityPub feed => iframe embed.
92 commits 7 branches 0 tags 568 KiB
CSS 42.3%
HTML 32.1%
JavaScript 14.9%
EJS 6.7%
SCSS 4%
Find a file
dependabot[bot] 9653fa5d1a
Bump path-parse from 1.0.6 to 1.0.7 
Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7.
- [Release notes](https://github.com/jbgutierrez/path-parse/releases)
- [Commits](https://github.com/jbgutierrez/path-parse/commits/v1.0.7)

---
updated-dependencies:
- dependency-name: path-parse
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-08-11 15:53:32 +00:00
lib fix some visual bugs 2020-04-04 13:21:51 -04:00
static fix some visual bugs 2020-04-04 13:21:51 -04:00
stylesrc fix some visual bugs 2020-04-04 13:21:51 -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 add auto color scheme 2019-11-04 17:22:03 -05:00
index.js add logging to redirects 2019-08-05 16:34:09 -04:00
LICENSE Create LICENSE 2017-04-30 13:04:48 -05:00
package.json improve logger 2019-08-02 13:24:31 -04:00
README.md Update README.md 2019-11-05 10:04:43 -05:00
yarn.lock Bump path-parse from 1.0.6 to 1.0.7 2021-08-11 15:53:32 +00: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, light or auto, to select the UI theme (default is dark). auto will appear light unless the user sets up dark mode on their device.
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, light or auto, to select the UI theme (default is dark). auto will appear light unless the user sets up dark mode on their device.
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.