Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/botwiki/fediverse-bot
A self-hosted fediverse bot.
https://github.com/botwiki/fediverse-bot
activitypub bots fediverse indieweb mastodon
Last synced: about 2 months ago
JSON representation
A self-hosted fediverse bot.
- Host: GitHub
- URL: https://github.com/botwiki/fediverse-bot
- Owner: botwiki
- License: mit
- Created: 2018-09-29T12:42:29.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T15:46:07.000Z (almost 2 years ago)
- Last Synced: 2024-05-23T04:40:56.564Z (4 months ago)
- Topics: activitypub, bots, fediverse, indieweb, mastodon
- Language: JavaScript
- Homepage: https://fediverse-bot.glitch.me/
- Size: 931 KB
- Stars: 31
- Watchers: 6
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Fediverse bot
Make creative online bots that anyone [in the fediverse](https://en.wikipedia.org/wiki/Fediverse) can follow! This project is [under active development](https://github.com/botwiki/fediverse-bot/issues) and contributions and feature suggestions are welcome.
- [Import to Glitch](https://glitch.com/#!/import/github/botwiki/fediverse-bot) ([Learn more](https://glitch.com/about))
## Bot administration
You can log into the admin panel by going to `/admin` and logging in using the password set inside your `.env` file. This will allow you to delete your bot's posts one by one. (Multi-post deletion is coming!)
## Bot logic (the back end)
1. Update your bot's main script in `bot/script.js`.
2. Set up your bot's schedule in `server.js`.
```
(new CronJob(cronSchedules.EVERY_SIX_HOURS, () => {bot.script()})).start();
```
See `helpers/cron-schedules.js` for common schedules, or the cron package documentation at https://www.npmjs.com/package/cron to create your own.
## The look of your bot's page (the front end)
You can update the style files inside `src/styles`. You can use [sass](https://sass-lang.com/guide), it will be compiled using [node-sass-middleware](https://github.com/sass/node-sass-middleware). Update the scripts inside `src/scripts`.
You can use [ES6](http://es6-features.org/#Constants), you script files will be compiled using [express-babelify-middleware](https://github.com/luisfarzati/express-babelify-middleware). All templates are inside the `views` folder and use [handlebars.js](http://handlebarsjs.com/).
## TO-DO:
[See issues on GitHub.](https://github.com/fourtonfish/fediverse-bot/issues)
## Resources:
- [ActivityPub documentation](https://github.com/w3c/activitypub) (github.com)
- [How to implement a basic ActivityPub server](https://blog.joinmastodon.org/2018/06/how-to-implement-a-basic-activitypub-server/) (blog.joinmastodon.org)
- [What is necessary for Mastodon to be able to fetch my profile and a list of posts from my blog?](https://github.com/tootsuite/mastodon/issues/1441) (github.com)
- [express-activitypub](https://github.com/dariusk/express-activitypub) (github.com)
## Debugging/testing
- [webfinger output](https://fediverse-bot.glitch.me/.well-known/webfinger?resource=acct:[email protected])
- [the Actor object](https://fediverse-bot.glitch.me/bot?debug=true)