A simple bot for reminding a nostr user about events that happen. Interaction with the bot is done through replies on the event to receive the reminder. Simply add a reply to an event, including the bot in the message with a time. Below is an example:

nostr:npub16uy98al5gzdrhy4aztdyw385ddhkvhphdv66fglpg7dwxchennmsxcckxs in 5 minutes

Single timeframes supported by the humantime crate are supported by the bot.

The application is written in Rust. Therefore, rustup should be used to get Rust and friends installed on your machine.

Once installed, copy the .env.example file to .env. Also create the initial database file:

cp .env.example .env
touch remindme.db

Lastly, run the project using cargo, turning on debug logs for local development.

RUST_LOG=remindme=debug cargo run -p remindme

There are only a few extra dependencies needed on the system to build the project.

sudo apt update
sudo apt install -y build-essential libsqlite3-dev

There is a flake.nix file that can be used for an easy local development setup with the needed tools. Use nix develop if direnv isn't setup. If you are using direnv, run direnv allow to get the environment tools installed locally.

PRs are more than welcome! I don't know how much more needs to be added, but I'm open to ideas.

Feeling generous? Leave me a tip! ⚡️[email protected].

Think I'm an asshole but still want to tip? Please donate to OpenSats.

Want to tell me how you feel? Hit me up on Nostr.

Distributed under the AGPLv3 License. See LICENSE.txt for more information.