Mastodon
/
mastofeed-iframe-embed
mirror of https://github.com/fenwick67/mastofeed
1
0
Fork 0
Code Issues Releases Wiki Activity
Incorpora un feed di un account mastodon nel tuo blog o sito Uno strumento per generare il codice iframe, i feed si inseriscono comodamente in un'area larga 400px. https://mastodon.uno/
110 Commits 5 Branches 0 Tags 1.6 MiB
JavaScript 43.1%
CSS 29.4%
EJS 10.6%
HTML 8.9%
SCSS 8%
Go to file
Nicco Kunzmann 1fc5890ec6 how to watch lib folder 2022-04-28 20:53:52 +00:00
lib remove Quirks mode 2022-04-28 20:53:30 +00:00
static remove Quirks mode 2022-04-28 20:53:30 +00: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 ignore nano 2022-04-28 20:53:12 +00:00
LICENSE-AGPL add license AGPL 2022-04-28 18:32:53 +00:00
LICENSE-MIT add license AGPL 2022-04-28 18:32:53 +00:00
README.md how to watch lib folder 2022-04-28 20:53:52 +00:00
build-styles.js add license AGPL 2022-04-28 18:32:53 +00:00
index.js add hastag url in readme 2022-04-28 19:57:12 +00:00
package.json improve logger 2019-08-02 13:24:31 -04:00
yarn.lock update yarn dependencies 2022-04-28 19:23:15 +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 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.

  1. install NodeJS and npm
  2. install yarn 
    npm -g install yarn
  3. 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.
  4. 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

MIT License: Copyright 2017 fenwick67 AGPL License: Copyright 2022 Nicco Kunzmann

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

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.