3.1 KiB

Raw Blame History

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	value	default
`userurl`	yes	Mastodon/ActivityPub account URL or hashtag URL	`https://${instance}/tags/${tagname}` `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	`auto` will appear light unless the user sets up dark mode on their device.	either `dark`, `light` or `auto`, to select the UI theme	`dark`
`boosts`	no	whether to show boosts or not	`yes` or `no`	`yes`
`replies`	no	whether to show replies or not	`yes` or `no`	`yes`
`size`	no	the scale of the UI in percent.	e.g. `200`	`100`
`header`	no	whether to show the user header (only for users, not hashtags)	`yes` or `no`	`no`

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.

install NodeJS and npm
install yarn
```
npm -g install yarn
```
install the packages
```
yarn install
```
You may need to have Python2 installed if you cannot install node-sass or remove the line in the devDependencies in package.json. You do not need it for small fixes.
run npm start

If you want automatic reloading of files during development, you can install nodemon:

npm install -g nodemon

Run it:

nodemon index.js --watch lib

Improve me

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

License

Deprecated

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') ).