README.md

# Real Estate Bot

**AI-Powered Real Estate Assistant**

Author: RSK World (https://rskworld.in)
Founded by: Molla Samser
Designer & Tester: Rima Khatun
Contact: info@rskworld.com, +91 93305 39277
Year: 2026

## 🏠 Description

Real Estate Bot is an intelligent chatbot application designed to help users search for properties, schedule viewings, and get comprehensive information about real estate listings. Built with Python, Flask, and OpenAI API, this bot provides a conversational interface for property discovery and management.

## ✨ Features

- **🔍 Property Search**: Find properties based on location, price range, property type, bedrooms, and other criteria
- **📅 Viewing Scheduling**: Schedule property viewings with preferred dates and times
- **💬 Property Inquiries**: Get detailed information about specific properties
- **📍 Location Information**: Learn about neighborhoods and areas
- **🤖 AI-Powered Chat**: Natural language processing with OpenAI GPT
- **💾 Database Management**: SQLite database for properties, appointments, and user data
- **🌐 Web Interface**: Modern, responsive web UI with real-time chat
- **📱 Mobile Friendly**: Fully responsive design for all devices

## 🛠️ Technologies Used

- **Backend**: Python 3.8+, Flask
- **AI/ML**: OpenAI GPT API
- **Database**: SQLite
- **Frontend**: HTML5, CSS3, JavaScript (ES6+)
- **UI Framework**: Bootstrap 5
- **Icons**: Font Awesome
- **HTTP Client**: Requests
- **Environment Management**: python-dotenv

## 📋 Requirements

- Python 3.8 or higher
- pip package manager
- OpenAI API key
- Modern web browser

## 🚀 Installation

1. **Clone the repository**
```bash
git clone <repository-url>
cd real-estate-bot
```

2. **Create virtual environment**
```bash
python -m venv venv

# Windows
venv\Scripts\activate

# macOS/Linux
source venv/bin/activate
```

3. **Install dependencies**
```bash
pip install -r requirements.txt
```

4. **Set up environment variables**
```bash
cp .env.example .env
```

Edit `.env` file and add your API keys:
```env
OPENAI_API_KEY=your_openai_api_key_here
SECRET_KEY=your_secret_key_here
```

5. **Initialize the database**
The database will be automatically created when you run the application for the first time.

## 🏃‍♂️ Running the Application

1. **Start the Flask application**
```bash
python src/app.py
```

2. **Open your web browser**
Navigate to `http://localhost:5000`

3. **Start chatting!**
The bot will be ready to help you find properties and answer your real estate questions.

## 📁 Project Structure

```
real-estate-bot/
├── src/
│ ├── app.py # Main Flask application
│ ├── chatbot.py # Chatbot logic and AI integration
│ ├── database.py # Database management
│ └── property_search.py # Property search engine
├── templates/
│ └── index.html # Main web interface
├── static/
│ ├── css/
│ │ └── style.css # Custom styles
│ └── js/
│ └── chat.js # Frontend JavaScript
├── data/
│ └── real_estate_bot.db # SQLite database
├── tests/
│ └── test_*.py # Unit tests
├── requirements.txt # Python dependencies
├── .env # Environment variables
└── README.md # This file
```

## 💬 Usage Examples

### Property Search
- "Show me apartments in Mumbai under 50 lakhs"
- "Find 3-bedroom houses in Delhi"
- "I'm looking for a 2BHK flat in Bangalore with parking"

### Schedule Viewings
- "Schedule a viewing for property 123"
- "I want to visit the apartment in Pune tomorrow"
- "Book an appointment for the house in Chennai"

### Property Information
- "Tell me about property 456"
- "What's the price of the 3BHK in Mumbai?"
- "What amenities are available in the Bangalore property?"

### Location Queries
- "Tell me about the neighborhood in Delhi"
- "What schools are near the property in Pune?"
- "How is the connectivity in Mumbai?"

## 🔧 Configuration

### Environment Variables

- `OPENAI_API_KEY`: Your OpenAI API key (required)
- `SECRET_KEY`: Flask secret key for sessions
- `DATABASE_URL`: Database connection URL (default: SQLite)
- `REAL_ESTATE_API_KEY`: External real estate API key (optional)
- `REAL_ESTATE_API_URL`: External real estate API URL (optional)

### Database Schema

The application uses SQLite with the following tables:

- **properties**: Property listings and details
- **users**: User information and preferences
- **appointments**: Scheduled property viewings
- **inquiries**: Property-related inquiries
- **chat_history**: Conversation logs

## 🧪 Testing

Run the test suite:
```bash
python -m pytest tests/
```

Or run individual tests:
```bash
python -m pytest tests/test_chatbot.py
python -m pytest tests/test_database.py
python -m pytest tests/test_property_search.py
```

## 🔌 API Endpoints

### Chat API
- `POST /api/chat` - Send message to chatbot
- `GET /api/chat/history` - Get conversation history

### Property API
- `POST /api/properties/search` - Search properties
- `GET /api/properties/<id>` - Get property details
- `GET /api/properties/<id>/similar` - Get similar properties

### Appointment API
- `POST /api/appointments/schedule` - Schedule viewing
- `GET /api/appointments/<user_id>` - Get user appointments

### Inquiry API
- `POST /api/inquiries/submit` - Submit property inquiry

## 🎨 Customization

### Adding New Property Types
Edit the `property_types` dictionary in `src/chatbot.py` to add new property types and keywords.

### Modifying Search Criteria
Update the search logic in `src/property_search.py` to add new search filters and criteria.

### Customizing UI
Modify the HTML templates and CSS files in the `templates/` and `static/css/` directories.

## 🚀 Deployment

### Production Deployment with Gunicorn
```bash
pip install gunicorn
gunicorn -w 4 -b 0.0.0.0:5000 src.app:app
```

### Docker Deployment
```dockerfile
FROM python:3.9-slim

WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt

COPY . .
EXPOSE 5000

CMD ["gunicorn", "-w", "4", "-b", "0.0.0.0:5000", "src.app:app"]
```

### Environment Variables for Production
- Set `FLASK_ENV=production`
- Use a strong `SECRET_KEY`
- Configure proper database connections
- Set up proper logging

## 🔒 Security Considerations

- Keep your OpenAI API key secure and never commit it to version control
- Use environment variables for sensitive configuration
- Implement rate limiting for API endpoints
- Validate and sanitize all user inputs
- Use HTTPS in production
- Regularly update dependencies

## 🤝 Contributing

1. Fork the repository
2. Create a feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

## 📞 Support

For support and inquiries:

- **Email**: info@rskworld.com
- **Phone**: +91 93305 39277
- **Website**: https://rskworld.in
- **Support**: support@rskworld.com

## 🙏 Acknowledgments

- OpenAI for the powerful GPT API
- Flask team for the excellent web framework
- Bootstrap for the responsive UI components
- Font Awesome for the beautiful icons

---

**© 2026 RSK World. All rights reserved.**

*Developed by Molla Samser*
*Designed & Tested by Rima Khatun*

*Content used for educational purposes only. View [Disclaimer](https://rskworld.in/disclaimer.php)*