{"id":16514029,"url":"https://github.com/twin/discord-reminder-bot","last_synced_at":"2025-03-02T11:16:10.404Z","repository":{"id":61626493,"uuid":"365082879","full_name":"TwiN/discord-reminder-bot","owner":"TwiN","description":"Lightweight Discord bot for managing reminders.","archived":false,"fork":false,"pushed_at":"2022-09-05T03:44:33.000Z","size":11398,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-12T23:12:08.703Z","etag":null,"topics":["bot","discord","reminder","remindme"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TwiN.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-07T01:37:29.000Z","updated_at":"2024-11-26T23:39:43.000Z","dependencies_parsed_at":"2022-10-19T19:00:25.823Z","dependency_job_id":null,"html_url":"https://github.com/TwiN/discord-reminder-bot","commit_stats":null,"previous_names":["twinproduction/discord-reminder-bot"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fdiscord-reminder-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fdiscord-reminder-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fdiscord-reminder-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TwiN%2Fdiscord-reminder-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TwiN","download_url":"https://codeload.github.com/TwiN/discord-reminder-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241494184,"owners_count":19971871,"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","discord","reminder","remindme"],"created_at":"2024-10-11T16:11:12.217Z","updated_at":"2025-03-02T11:16:10.386Z","avatar_url":"https://github.com/TwiN.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# discord-reminder-bot\n![test](https://github.com/TwiN/discord-reminder-bot/workflows/test/badge.svg?branch=master)\n[![Docker pulls](https://img.shields.io/docker/pulls/twinproduction/discord-reminder-bot)](https://cloud.docker.com/repository/docker/twinproduction/discord-reminder-bot)\n\nThis is a simple Discord bot for managing reminders.\n\n\n## Table of Contents\n- [Description](#description)\n- [Usage](#usage)\n- [Getting started](#getting-started)\n    - [Discord](#discord)\n- [Docker](#docker)\n    - [Pulling from Docker Hub](#pulling-from-docker-hub)\n    - [Building image locally](#building-image-locally)\n\n\n## Description\nIf you react to a message with ⏰ (`:alarm_clock:`), ⏲ (`:timer:`) or 🎗 (`:reminder_ribbon:`), a message will be sent \nto you through direct message informing you that you will be reminded about the message you reacted to in 8 hours.\n\nYou may also use the following syntax:\n```\n!RemindMe \u003cDURATION\u003e [NOTE]\n```\n**Where:**\n- `\u003cDURATION\u003e` must be use one of the following formats: `30m`, `2h`, `6h30m`, `30d`, `7d12h30m`\n- `[NOTE]` is an optional note to attach to the reminder with less than 240 characters\n\nNote that `!RemindMe` can be replaced by directly pinging the bot (e.g. `@reminder-bot 2h30m meeting about cookies`)\n\nOnce a reminder is created using one of the aforementioned methods, a direct message is sent to the user with several\noptions to manage the newly created reminder. This is internally referred to as the notification message:\n\n![new reminder](.github/assets/reminder-new.png)\n\nOnce a reminder is due, a direct message is sent to the user with a link to the message that triggered the creation\nof the reminder.\n\nHere is an example of a message with and without a note:\n\n![reminder](.github/assets/reminder.png)\n\nFurthermore, once a reminder has been deleted or has been processed, its notification message is automatically crossed\nto make the differentiation between active and inactive reminders:\n\n![deleted reminder](.github/assets/reminder-crossed.png)\n\n\nYou may also list your active reminders by typing the following:\n```\n!list\n```\n\n![list of reminders](.github/assets/reminder-list.png)\n\n\n## Usage\n| Environment variable | Description                           | Required | Default |\n|:-------------------- |:------------------------------------- |:--- |:---- |\n| DISCORD_BOT_TOKEN    | Discord bot token                     | yes | `\"\"` |\n| COMMAND_PREFIX       | Character prepending all bot commands | no  | `!`  |\n\n\n## Getting started\n### Discord\n1. Create an application\n2. Add a bot in your application\n3. Save the bot's token and set it as the `DISCORD_BOT_TOKEN` environment variable\n4. Go to `https://discordapp.com/oauth2/authorize?client_id=\u003cYOUR_BOT_CLIENT_ID\u003e\u0026scope=bot\u0026permissions=2112`\n5. Add the bot to a server of your choice\n\n\n## Docker\n### Pulling from Docker Hub\n```\ndocker pull twinproduction/discord-reminder-bot\n```\n\n### Building image locally\nBuilding the Docker image is done as following:\n```\ndocker build . -t twinproduction/discord-reminder-bot\n```\nYou can then run the container with the following command:\n```\ndocker run -e DISCORD_BOT_TOKEN=secret --name discord-reminder-bot twinproduction/discord-reminder-bot\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwin%2Fdiscord-reminder-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftwin%2Fdiscord-reminder-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftwin%2Fdiscord-reminder-bot/lists"}