Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muneerahmed03/mindr-bot
Save and retrieve any thought, idea or memory just by texting.
https://github.com/muneerahmed03/mindr-bot
cloudflare-workers honojs postgresql supabase telegram telegram-bot vectors workers-ai
Last synced: about 1 month ago
JSON representation
Save and retrieve any thought, idea or memory just by texting.
- Host: GitHub
- URL: https://github.com/muneerahmed03/mindr-bot
- Owner: MuneerAhmed03
- Created: 2024-08-11T14:52:25.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-12-10T07:46:55.000Z (about 2 months ago)
- Last Synced: 2024-12-10T08:30:43.340Z (about 2 months ago)
- Topics: cloudflare-workers, honojs, postgresql, supabase, telegram, telegram-bot, vectors, workers-ai
- Language: TypeScript
- Homepage: https://mindr.live
- Size: 224 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# [MindR Telegram Bot](https://mindr.live/)
MindR is a RAG-based (Retrieval-Augmented Generation) Telegram bot that allows users to store and retrieve text messages easily. Users can send any text message to the chat and later retrieve it using the `/ask` command followed by a query.
## Snapshots
## Features
- Store text messages in a chat
- Retrieve messages using natural language queries
- Built with modern, efficient technologies
## Tech Stack
- **Runtime**: Bun
- **Framework**: Hono.js
- **Deployment**: Cloudflare Workers
- **Database**: Supabase PostgreSQL
- **AI**: Workers AI for embeddings and response generation
## Setup Instructions
### Prerequisites
- [Bun](https://bun.sh/) installed on your system
- A [Cloudflare](https://www.cloudflare.com/) account
- A [Supabase](https://supabase.com/) account
- A [Telegram Bot Token](https://core.telegram.org/bots#how-do-i-create-a-bot)
### Steps
1. Clone the repository:
```
git clone https://github.com/yourusername/mindr-telegram-bot.git
cd mindr-telegram-bot
```
2. Install dependencies:
```
bun install
```
3. Set up the Supabase database locally:
```
bunx supabase init
```
- Make sure Docker is running.
```
bunx supabase start
bunx supabase migrations up
```
- Go to your supabase project dashboard and run this query in sql editor:
```
select vault.create_secret(
'YOUR_WORKERS_URL',
'workers_url'
);
```
4. Set up environment variables:
Create a `.dev.vars` file in the root directory and add the following:
````
TELEGRAM_BOT_TOKEN=your_telegram_bot_token
SUPABASE_URL=your_supabase_project_url
SUPABASE_KEY=your_supabase_api_key
```
````
5. Deploy to Cloudflare Workers:
```
bun run deploy
```
6. Set up the Telegram bot webhook:
Replace `YOUR_WORKER_URL` with your Cloudflare Worker URL
````
curl -F "url=YOUR_WORKER_URL" https://api.telegram.org/bot/setWebhook
```
````
## Usage
1. Start a chat with your bot on Telegram
2. Send any text message to store it
3. Use the `/ask` command followed by your query to retrieve relevant messages
Example: `/ask What did I say about project deadlines?`
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.