gm_bot

Forked from neynarxyz/farcaster-examples

Introduction

gm_bot is an automated messaging bot designed to cast a 'gm' message in Warpcast every day at a scheduled time. It leverages Neynar API and is built using @neynar/nodejs-sdk.

Quick Start with Docker

1. Create .env file:

   # 24 hour time format (HH:MM). Defaults to 09:00
   PUBLISH_CAST_TIME=09:00
   # Timezone for scheduling. Defaults to UTC
   TIME_ZONE=UTC
   # Get from https://neynar.com
   NEYNAR_API_KEY=your-api-key-here
   # Create on Neynar Dashboard
   SIGNER_UUID=your-signer-uuid-here

   Get your NEYNAR_API_KEY and SIGNER_UUID from the Neynar Dashboard.

2. Run with Docker:

   docker run -d \
     --name farcaster-gm-bot \
     --env-file .env \
     --restart unless-stopped \
     ghcr.io/ctrl-a-d/farcaster-gm-bot:main

3. View Logs:

   docker logs -f farcaster-gm-bot

Local Development

Local development requires Node.js 24 or newer.

npm ci
npm start

License

gm_bot is released under the MIT License. This license permits free use, modification, and distribution of the software, with the requirement that the original copyright and license notice are included in any substantial portion of the work.