Skip to content

Latest commit

 

History

History
116 lines (93 loc) · 3.19 KB

README.md

File metadata and controls

116 lines (93 loc) · 3.19 KB

Telegram Rental Bot 🏠

Designed to streamline property rentals in Dubai, offering an intuitive interface for both property seekers and listers.

Telegram Bot Node.js Supabase Railway GitHub

🌟 Features

  • Advanced Property Search

    • Filter by property type (Studio, 1BHK, Villa, etc.)
    • Set minimum and maximum price ranges
    • Search by location
    • Skip any filter for broader results

  • Property Listing Management

    • Upload up to 10 photos per property
    • Detailed property descriptions
    • Contact information verification
    • Price and location validation

  • User-Friendly Interface

    • Custom keyboards for easy navigation
    • Interactive buttons for property browsing
    • Step-by-step listing process
    • Clear property display with pagination

📦 Installation

  1. Clone the repository:
git clone https://github.com/LeoFreyre/bot-find-home-dubai.git
cd bot-find-home-dubai
  1. Install dependencies:
npm install
  1. Create a .env file with the following variables:
TELEGRAM_BOT_TOKEN=your_bot_token
SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_key
PORT=3000
  1. Set up Supabase:
    • Create a new project in Supabase
    • Create a 'properties' table with the following schema: 
      CREATE TABLE properties (
  id SERIAL PRIMARY KEY,
  description TEXT NOT NULL,
  price NUMERIC NOT NULL,
  type TEXT NOT NULL,
  location TEXT NOT NULL,
  contact_info TEXT NOT NULL,
  photos TEXT[] NOT NULL,
  created_at TIMESTAMP WITH TIME ZONE DEFAULT TIMEZONE('utc', NOW()),
  user_id BIGINT NOT NULL,
  verified_by_admin TEXT DEFAULT '-'
);

🚀 Usage

  1. Start the bot:
npm start

  1. Add your bot on Telegram by searching for your bot's username

  2. Start interacting with the bot using these commands:

    • /start - Initialize the bot
    • 🏡 Search Property - Start property search
    • 📤 Upload Property - List a new property
    • 🌐 Website - Visit the website
    • 📞 Contact Agent - Contact support

💻 Technology Stack

  • Node.js - Backend runtime environment
  • Supabase - Database and storage
  • Railway - Deployment platform
  • Telegram Bot API - Bot interface

📋 Property Types

The bot supports these property types:

  • Studio
  • Maid's Room
  • Sharing
  • 1BHK to 4BHK+
  • Penthouse
  • Duplex
  • Loft
  • Villa
  • Warehouse

🎯 Demo

Try the bot here: @FindHomeDXB_bot

📄 License

This project is licensed under the MIT License.