Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PangoraWeb/remindme-bot
A pangora/lemmy/kbin bot that reminds you after an amount of time
https://github.com/PangoraWeb/remindme-bot
bot bots fediverse fediverse-bot javascript kbin lemmy lemmy-bot pangora
Last synced: 25 days ago
JSON representation
A pangora/lemmy/kbin bot that reminds you after an amount of time
- Host: GitHub
- URL: https://github.com/PangoraWeb/remindme-bot
- Owner: PangoraWeb
- License: agpl-3.0
- Created: 2023-07-17T13:56:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-14T00:17:27.000Z (about 1 year ago)
- Last Synced: 2024-08-03T17:09:17.749Z (4 months ago)
- Topics: bot, bots, fediverse, fediverse-bot, javascript, kbin, lemmy, lemmy-bot, pangora
- Language: JavaScript
- Homepage: https://matrix.to/#/#pangora:matrix.org
- Size: 110 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-lemmy - remindme-bot - bot)  (Projects / Tools)
README
[](https://github.com/PippitWeb/pippit/issues)
[](LICENSE)
## About the Bot
The remindme bot responds to you after a period of time to remind you about something (e.g. if someone in a post says theyre going to do something after a week and you want to be there for that)
Theres a version of this bot being hosted currently in programming.dev. You can still self host your own if you want to do things like customize it a bit more for your community but its not required. All remindme bots can work simultaneously since its triggered off of mentions as opposed to a command.
## Usage
To use the bot you need to mention it and put a length of time somewhere in the message.
`Example: @[email protected] 5 years`
`Example: @[email protected] remind me about this in 2 minutes`
In order to function in your community you need to request that it be added to the whitelist in the issues tab in this repository (only mods + admins of the community can request)
## Self-Hosting Setup
You need node.js downloaded to run this
1. Clone the repository (`git clone https://github.com/PangoraWeb/remindme-bot.git` in a terminal)
2. Create an account in the instance you want the bot to have as its home (just make a regular user)
3. Create a file called .env in the bot folder and give it values in this format with the data in the quotes (dont add the slashes or the part after the slashes)
```
LEMMY_INSTANCE="" // The instance the bot account is in
LEMMY_USERNAME="" // The bot username
LEMMY_PASSWORD="" // The bot password
```
4. Change the data in config.yaml based on what you want set
5. Open a terminal in the bot folder and run `npm install` to install dependendies and then `node main.js` to run the bot (whenever you want to start the bot again you can just do ctrl+c to interrupt the process and node main.js to start the bot)
I recommend installing something like [forever.js](https://www.npmjs.com/package/forever) for running it in the background on your server
If you run into issues feel free to dm me on Matrix [here](https://matrix.to/#/@ategon:matrix.org)
## Contributing
If you want to contribute to add some sort of feature feel free to make a pull request with it added
[This repository](https://github.com/firstcontributions/first-contributions) has some info on how to do development in a repository and make a pull request
## Credits
Icon base by [Delapouite](https://delapouite.com/) under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) with modifications to add a gradient