@remindr - Reminder Bot for Twitter and Farcaster

A powerful bot that allows users to set reminders by tagging @remindr in their posts. The bot will then mention them with the reminder message at the specified date/time.

Features

• Multi-Platform: Works on both Twitter/X and Farcaster
• Natural Language Parsing: Understands human-friendly time formats
• Flexible Timing: Set reminders for relative times (hours, days, weeks) or specific dates
• Persistence: Reminders are saved even if the bot restarts
• Confirmation: Bot confirms when reminders are set successfully
• Telegram Integration: Can also be used via Telegram

Examples

How to Use @remindr

Just tag @remindr in your post with the following format:

@remindr remind me in [time] about [message]

or

@remindr remind me on [date] about [message]

Examples:

• @remindr remind me in 2 hours about checking the market
• @remindr remind me in 3 days about the community call
• @remindr remind me on 2023-12-25 about Christmas dinner

Installation

Using Docker (Recommended)

1. Clone the repository:

git clone https://github.com/aipop-fun/remindr-bot
cd remindr-bot

2. Create and configure the .env file:

cp .env.sample .env
# Edit .env with your API credentials

3. Build and start the container:

docker-compose up -d

Manual Installation

1. Clone the repository:

git clone https://github.com/aipop-fun/remindr-bot
cd remindr-bot

2. Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

3. Install dependencies:

pip install -r requirements.txt

4. Configure environment variables:

cp .env.sample .env
# Edit .env with your API credentials

5. Run the bot:

python remindr_bot.py

Configuration

Create a .env file with the following variables:

# Telegram
TELEGRAM_TOKEN=your_telegram_token

# Twitter/X
TWITTER_BEARER_TOKEN=your_twitter_bearer_token
TWITTER_API_KEY=your_twitter_api_key
TWITTER_API_SECRET=your_twitter_api_secret
TWITTER_ACCESS_TOKEN=your_twitter_access_token
TWITTER_ACCESS_SECRET=your_twitter_access_secret

# Farcaster
FARCASTER_MNEMONIC=your_farcaster_mnemonic

API Keys Setup

Twitter/X

1. Go to the Twitter Developer Portal
2. Create a new Project and App
3. Apply for Elevated access to use the v2 API
4. Generate API Key, API Secret, Access Token, and Access Secret
5. Enable read and write permissions for your app

Farcaster

1. Create a Farcaster account
2. Generate a mnemonic phrase for bot access
3. Fund the associated wallet with enough FIL for operations

Telegram

1. Talk to @BotFather on Telegram
2. Create a new bot using the /newbot command
3. Copy the token provided by BotFather

Monitoring and Maintenance

View Logs

Using Docker:

docker-compose logs -f

Manual installation:

tail -f remindr_bot.log

Stop the Bot

Using Docker:

docker-compose down

Manual installation: Use Ctrl+C in the terminal running the bot

License

This project is licensed under the MIT License.