Skip to content

Repository files navigation

MaPlefeed

Open source tool to create Mastodon or Pleroma feed and display it on any web page.

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%2Fmastodon.social%2Fusers%2Fabidnev&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://mastodon.social/users/abidnev') ).

Querystring options:

optionrequireddescription
userurlyesMastodon/ActivityPub account URL (usually https://${instance}/users/${username})
feedurlnoa URL to a page of an ActivityPub post collection. Only used for pages beyond the first.
themenoeither 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.
boostsnowhether to show boosts or not
repliesnowhether to show replies or not
sizenothe 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%2Fmastodon.social%2Fusers%2Fabidnev.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://mastodon.social/users/abidnev.atom') ).

Querystring options:

optionrequireddescription
urlyesMastodon Atom feed URL
themenoeither 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.
sizenothe 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.

About

MaPleFeed - Mastodon & Pleroma Feed generator https://maplefeed.bihlink.com

Topics

Resources

Stars

7 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages