Quickstart

Get NotebookTG running locally in minutes.

Clone and Setup

Get the code and create your environment file

git clone https://github.com/Sardorchikdev/NotebookTG.git
cd NotebookTG
cp .env.example .env

Configure Environment

Edit .env with your API keys

BOT_TOKEN=your_telegram_bot_token
GROQ_API_KEY=your_groq_api_key
# For local dev, defaults work:
# DATABASE_URL=sqlite+aiosqlite:///./data/notebooktg.db
# VECTOR_BACKEND=memory

Run the Bot

Start the Telegram bot

python main.py

Use Commands

Interact with your bot in Telegram

/newnotebook "My Research"
/help

Docker Setup

Run the full stack with PostgreSQL and Qdrant:

cp .env.example .env
docker compose up -d postgres qdrant
make migrate
make bot  # or make api

Environment Variables

BOT_TOKENTelegram bot token

GROQ_API_KEYLLM provider API key

DEFAULT_MODELMain chat model

DATABASE_URLSQLAlchemy connection

VECTOR_BACKENDqdrant or memory

QDRANT_URLQdrant server URL

Need Help?

Check the README for full documentation.