{"id":13770511,"url":"https://github.com/PangoraWeb/remindme-bot","last_synced_at":"2025-05-11T03:32:47.325Z","repository":{"id":181836844,"uuid":"667437235","full_name":"PangoraWeb/remindme-bot","owner":"PangoraWeb","description":"A pangora/lemmy/kbin bot that reminds you after an amount of time","archived":false,"fork":false,"pushed_at":"2023-11-14T00:17:27.000Z","size":113,"stargazers_count":8,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-07T00:56:42.349Z","etag":null,"topics":["bot","bots","fediverse","fediverse-bot","javascript","kbin","lemmy","lemmy-bot","pangora"],"latest_commit_sha":null,"homepage":"https://matrix.to/#/#pangora:matrix.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PangoraWeb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2023-07-17T13:56:01.000Z","updated_at":"2024-05-25T11:03:53.000Z","dependencies_parsed_at":"2023-07-17T20:41:38.727Z","dependency_job_id":"f5d2fab4-91ed-48c0-b4ed-b68189779884","html_url":"https://github.com/PangoraWeb/remindme-bot","commit_stats":null,"previous_names":["ategon/lemmy-remindme-bot","pangoraweb/remindme-bot"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PangoraWeb%2Fremindme-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PangoraWeb%2Fremindme-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PangoraWeb%2Fremindme-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PangoraWeb%2Fremindme-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PangoraWeb","download_url":"https://codeload.github.com/PangoraWeb/remindme-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253514352,"owners_count":21920327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bot","bots","fediverse","fediverse-bot","javascript","kbin","lemmy","lemmy-bot","pangora"],"created_at":"2024-08-03T17:00:38.560Z","updated_at":"2025-05-11T03:32:46.952Z","avatar_url":"https://github.com/PangoraWeb.png","language":"JavaScript","funding_links":[],"categories":["Projects"],"sub_categories":["Tools"],"readme":"\u003cdiv align=\"center\"\u003e\n  \n![GitHub tag (latest SemVer)](https://img.shields.io/github/release/PangoraWeb/remindme-bot.svg?style=for-the-badge)\n[![GitHub issues](https://img.shields.io/github/issues-raw/PangoraWeb/remindme-bot.svg?style=for-the-badge)](https://github.com/PippitWeb/pippit/issues)\n[![License](https://img.shields.io/github/license/PangoraWeb/remindme-bot.svg?style=for-the-badge)](LICENSE)\n![GitHub stars](https://img.shields.io/github/stars/PangoraWeb/remindme-bot.svg?style=for-the-badge)\n\n\u003c/div\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/PangoraWeb/remindme-bot/assets/73616169/7b5a8297-7c60-4bb7-b09d-63feaa72803a\" width=200px height=200px\u003e\u003c/img\u003e\n  \u003ch3 align=\"center\"\u003e\u003ca href=\"\"\u003eRemindMe Bot\u003c/a\u003e\u003c/h3\u003e\n  \u003cp align=\"center\"\u003e\n    A reminder bot for Pangora, Lemmy, and Kbin to remind yourself after a period of time.\n  \u003c/p\u003e\n\u003c/div\u003e\n\n## About the Bot\nThe 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)\n\nTheres 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.\n\n## Usage\nTo use the bot you need to mention it and put a length of time somewhere in the message.\n\n`Example: @RemindMe@programming.dev 5 years`\n\n`Example: @RemindMe@programming.dev remind me about this in 2 minutes`\n\nIn 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)\n\n## Self-Hosting Setup\nYou need node.js downloaded to run this\n\n1. Clone the repository (`git clone https://github.com/PangoraWeb/remindme-bot.git` in a terminal)\n2. Create an account in the instance you want the bot to have as its home (just make a regular user)\n3. 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)\n```\nLEMMY_INSTANCE=\"\" // The instance the bot account is in\nLEMMY_USERNAME=\"\" // The bot username\nLEMMY_PASSWORD=\"\" // The bot password\n```\n4. Change the data in config.yaml based on what you want set\n5. 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)\n\nI recommend installing something like [forever.js](https://www.npmjs.com/package/forever) for running it in the background on your server\n\nIf you run into issues feel free to dm me on Matrix [here](https://matrix.to/#/@ategon:matrix.org)\n\n## Contributing\nIf you want to contribute to add some sort of feature feel free to make a pull request with it added\n\n[This repository](https://github.com/firstcontributions/first-contributions) has some info on how to do development in a repository and make a pull request\n\n## Credits\nIcon base by [Delapouite](https://delapouite.com/) under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) with modifications to add a gradient\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPangoraWeb%2Fremindme-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPangoraWeb%2Fremindme-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPangoraWeb%2Fremindme-bot/lists"}