🤖 askbrian

this repository contains the code for the powerful askbrian.

📋 features

This allows any AI Agent and farcaster user to interact with the Brian APIs to generate transactions.

it's extremely scalable due to the usage of Redis queues if enabled, allowing the bot to handle multiple requests at the same time without any issues whatsoever.

📦 installation

to install the bot, you need to follow these steps:

1. clone the repository

git clone https://github.com/builders-garden/askbrian.git
cd askbrian

2. install the dependencies using your package manager of choice

npm install # using npm
yarn install # using yarn
pnpm install # using pnpm
bun install # using bun

3. copy the .env.example file to .env and fill in the required fields. check the configuration section below for more information

cp .env.example .env

4. build and start the bot

npm run build && npm run start # using npm
yarn build && yarn start # using yarn
pnpm build && pnpm start # using pnpm
bun run build && bun run start # using bun

the bot should be running in the port of your choice (or 3000 if default).

in production enviroments it's better to use a process manager like PM2 to keep the bot running in the background.

npm install -g pm2
npm run build && pm2 start dist/index.js --name askbrian # using npm
yarn build && pm2 start dist/index.js --name askbrian # using yarn
pnpm build && pm2 start dist/index.js --name askbrian # using pnpm

⚙️ configuration

the only configuration needed for this bot is the .env file.

if you want to enable the Redis queues, you need to add the following environment variables:

REDIS_HOST="" # redis host
REDIS_PORT="" # redis port

this will allow the bot to connect to your Redis instance and start using the queues. if the queues are not enabled, the bot will work as a normal Express server and send the messages istantly. this is not recommended for production environments.

📡 webhooks

POST /webhooks/nominations

this endpoint is used to receive the nominations from warpcast and to generate a tx from the cast.

## 📝 license

this project is licensed under the **MIT License**. check the [LICENSE.md](/LICENSE.md) file for more information.