thyrail/mia-reminder-bot repository overview

⁠🌟 Mia Reminder Bot

A powerful Discord bot built with Node.js and Discord.js to provide daily reminders for Slack attendance notifications. It is designed to be easily deployed with Docker. 🚀

⁠📜 Features

• Daily Reminders:
  • Sends reminders at 09:02 AM and 02:02 PM (German time) to help you stay on top of your Slack attendance notifications.
• Custom Commands:
  • !mia: Test if the bot is active.
  • !test-9: Test the morning reminder.
  • !test-14: Test the afternoon reminder.
• Dockerized Deployment:
  • Easy to run with Docker Compose.

⁠🐋 Usage Instructions

⁠1️⃣ Pull the Image

Pull the latest version of the Mia Reminder Bot:

docker pull thyrail/mia-reminder-bot:latest

⁠2️⃣ Create a .env File

Before running the container, you need to set up a .env file to provide your Discord bot token and channel IDs. Create a .env file in your working directory with the following content:

DISCORD_TOKEN=your_discord_bot_token
DISCORD_MIA_BOT_CHANNEL_ID=your_mia_bot_channel_id
DISCORD_TESTS_CHANNEL_ID=your_test_channel_id

Replace your_discord_bot_token, your_mia_bot_channel_id, and your_test_channel_id with the appropriate values.

⁠3️⃣ Run the Container

Run the bot using Docker Compose:

docker compose up -d

Here is an example docker-compose.yml file you can use:

services:
  mia-reminder-bot:
    image: thyrail/mia-reminder-bot:latest
    container_name: mia-reminder-bot
    environment:
      - DISCORD_TOKEN=${DISCORD_TOKEN}
      - DISCORD_MIA_BOT_CHANNEL_ID=${DISCORD_MIA_BOT_CHANNEL_ID}
      - DISCORD_TESTS_CHANNEL_ID=${DISCORD_TESTS_CHANNEL_ID}
      - TZ=Europe/Berlin
    restart: unless-stopped

⁠4️⃣ Stop the Container

To stop the bot, use:

docker compose down

⁠🌐 Environment Variables

⁠🛠️ Debugging

Check the container logs to ensure the bot is running properly:

docker logs mia-reminder-bot

If you encounter any issues, verify the .env file and ensure your bot token and channel IDs are correct.

⁠📄 License

This project is licensed under the MIT-License⁠

⁠How to Update

To update to the latest version:

1. Pull the latest image:

docker pull thyrail/mia-reminder-bot:latest

1. Restart the container:

docker compose up -d

⁠Support

If you encounter any issues or have questions, feel free to open an issue on the GitHub repository.