Welcome to RemindMe!, a customizable reminder bot for your Discord server. This bot allows users to set reminders that trigger notifications at specified times using cron job scheduling.
To install and run RemindMe!, follow these steps:
$ git clone https://github.com/keenan-nicholson/remindme.git
$ cd remindme$ go install- Create a
.envfile in the root directory. See.env.distfor a template. - If running locally (without Docker) set desired paths for the database in
/database/db.goand logger in/utils/logger.go.
To run the bot using Docker Compose for an easy, reproducible setup:
-
Ensure your
.envfile is created with the required environment variables. -
Use Docker Compose to build and run the bot:
$ docker-compose up -d
This command builds the Docker image and starts the bot service. Logs will be displayed in your terminal. The bot will automatically restart if it crashes.
Commands
-
/settimer <duration> <unit> <user> <reminder message>- Description: Sets a timer that will trigger a reminder after a specified duration. The duration can be set in days, minutes, hours, or seconds.
- Example output:
Hey Keeborg, this is your reminder: take a study break!
-
/setdate <year> <month> <day> <hour> <minute> <user> <reminder message>- Description: Sets a reminder for a specific date and time. You provide the full date (year, month, day) along with the time (hour, minute). Currently only supports UTC.
- Example output:
Hey Keeborg, this is your reminder: you have a dentist appointment today!
$ go run main.goContributions are welcome! Please fork the repository and submit a pull request with your improvements.
This project is licensed under the MIT License. See the LICENSE file for details.