Skip to content

AdibSadman192/rent_house_bd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

12 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Create Release

🏠 rent_house_bd

🌟 Overview

A modern social media platform and service for house rentals in Bangladesh, connecting tenants with property owners through a community-driven approach.

🎯 Purpose

The platform serves as both a social network and rental service, making it easier for people in Bangladesh to find and list rental properties while building trusted connections within local communities.

πŸ‘₯ Key User Types

  • πŸ‘€ Regular Users (Tenants)
  • 🏘️ Property Owners
  • πŸ‘¨β€πŸŽ“ Bachelors
  • πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Families
  • πŸŽ“ Students
  • πŸ‘¨β€πŸ’Ό Administrators

✨ Features

🀝 Social & Community Features

  • πŸ’¬ Real-time chat between users
  • ⭐ Community reviews and ratings
  • πŸ”„ Social sharing capabilities
  • πŸ‘₯ User profiles and reputation system
  • πŸ“ Area-based community groups
  • πŸ€– AI-powered chatbot support

🏑 Rental Services

  • πŸ“ Property listing and management
  • πŸ” Advanced property search with filters
  • πŸ“… Booking management system
  • πŸ“„ Document verification
  • πŸ’³ Payment processing
  • πŸ“Š Property availability tracking

🎯 Specialized Categories

  • 🏒 Apartments
  • 🏠 Houses
  • πŸŽ“ Student hostels
  • πŸ‘₯ Mess accommodations
  • πŸ”„ Sublet options
  • πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Family units
  • πŸ‘¨β€πŸŽ“ Bachelor accommodations

πŸ”’ Security Features

  • πŸ” JWT Authentication
  • πŸ”‘ Password Hashing
  • πŸ›‘οΈ CORS Protection
  • πŸ”’ HTTP Security Headers
  • 🚫 Rate Limiting
  • 🧹 XSS Prevention
  • πŸ” Input Validation
  • πŸ“ Activity Logging

πŸ—ΊοΈ Project Roadmap

Phase 1: Foundation (Current)

  • Project setup and architecture
  • Basic UI components with glass-morphism design
  • Authentication system
  • Property listing core features
  • Search and filter functionality

Phase 2: Enhanced Features (Q1 2025)

  • Advanced property search with map integration
  • Real-time chat between users and property owners
  • Virtual tour integration
  • Review and rating system
  • Payment integration

Phase 3: Advanced Features (Q2 2025)

  • AI-powered property recommendations
  • Automated rental agreement generation
  • Mobile app development
  • Analytics dashboard for property owners
  • Multi-language support

Phase 4: Scaling & Optimization (Q3 2025)

  • Performance optimization
  • SEO enhancement
  • Advanced analytics
  • Market analysis tools
  • API marketplace for third-party integrations

πŸ“Š Current Project Status

Feature Status Notes
Authentication βœ… Working Email and social login implemented
User Profiles βœ… Working Basic profile management available
Property Listing ⚠️ Partial Basic listing without advanced features
Search System ⚠️ Partial Basic search implemented, advanced filters pending
Glass-morphism UI βœ… Working Complete component library with modern design
Responsive Design βœ… Working Fully responsive across all devices
Chat System ❌ Pending Planned for Phase 2
Payment System ❌ Pending Planned for Phase 2
Admin Dashboard ⚠️ Partial Basic management features available
Email Notifications βœ… Working Transactional emails implemented
Map Integration ❌ Pending Planned for Phase 2
Image Upload βœ… Working With optimization and CDN delivery
Property Analytics ❌ Pending Planned for Phase 3

🎯 Current Sprint Focus

  • Enhancing property search functionality
  • Implementing advanced filters
  • Optimizing image loading and caching
  • Improving user experience with smoother transitions
  • Adding more interactive elements to property listings

πŸ”„ Recent Updates

  • Implemented glass-morphism design system
  • Added responsive navigation
  • Enhanced user authentication flow
  • Optimized property listing performance
  • Added basic search functionality

πŸ› οΈ Development

Tech Stack

Backend

  • βš™οΈ Runtime: Node.js (v18+)
  • πŸš€ Framework: Express.js (v4.18.2)
  • πŸ“¦ Database: MongoDB (v7.5.0)
  • πŸ”„ ODM: Mongoose (v7.5.0)
  • πŸ”Œ Real-time: Socket.IO (v4.7.2)
  • πŸ” Authentication: JWT (v9.0.2)
  • ☁️ Storage: AWS S3
  • πŸ€– AI: Dialogflow (v4.7.0)
  • πŸ“ Logging: Morgan
  • πŸ›‘οΈ Security: Helmet, XSS-Clean, Express-Rate-Limit

Frontend

  • βš›οΈ Framework: Next.js 13 (React 18)
  • 🎨 UI Library: Material-UI (v5.15.10)
  • πŸ“ Forms: Formik (v2.4.5)
  • πŸ—ΊοΈ Maps: Leaflet (v1.9.4)
  • πŸ“Š Charts: Recharts (v2.8.0)
  • ✨ Icons: Material Icons
  • πŸ”„ State Management: React Context
  • πŸ“‘ HTTP Client: Axios
  • 🎭 Form Validation: Yup

DevOps & Tools

  • πŸ“¦ Package Manager: npm/yarn
  • πŸ”„ Version Control: Git
  • 🐳 Containerization: Docker (optional)
  • πŸ“ API Documentation: Swagger/OpenAPI
  • πŸ§ͺ Testing: Jest
  • πŸ“Š Code Quality: ESLint, Prettier
  • πŸ”„ CI/CD: GitHub Actions

Prerequisites

  • Node.js 18 or higher
  • MongoDB 7.x
  • npm or yarn
  • Git

Getting Started

  1. Clone the repository:
git clone https://github.com/yourusername/rent_house_bd.git
cd rent_house_bd
  1. Install dependencies:
# Install backend dependencies
cd backend
npm install

# Install frontend dependencies
cd ../frontend
npm install
  1. Set up environment variables:
# Backend (.env)
PORT=5000
MONGODB_URI=your_mongodb_uri
JWT_SECRET=your_jwt_secret
AWS_ACCESS_KEY=your_aws_access_key
AWS_SECRET_KEY=your_aws_secret_key
DIALOGFLOW_PROJECT_ID=your_dialogflow_project_id

# Frontend (.env.local)
NEXT_PUBLIC_API_URL=http://localhost:5000/api
  1. Start development servers:
# Start backend server
cd backend
npm run dev

# Start frontend server
cd frontend
npm run dev

API Documentation

  • Base URL: http://localhost:5000/api
  • Documentation: http://localhost:5000/api-docs

Development Guidelines

  • Follow ESLint and Prettier configurations
  • Write unit tests for new features
  • Follow Git branching strategy
  • Document API changes in Swagger
  • Keep dependencies updated

Deployment

  • Backend: Node.js server (PM2)
  • Frontend: Vercel/Netlify
  • Database: MongoDB Atlas
  • Storage: AWS S3
  • Monitoring: PM2/Sentry
  • SSL: Let's Encrypt

πŸ“„ License

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

πŸ‘₯ Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

πŸ“ž Support

For support, email support@renthousebd.com or join our Slack channel.