Smart-Rent-System

KO | EN

gitlite — search

#php #java #javascript #python #ruby #hacktoberfest #wordpress #nodejs #shell #c-plus-plus #logging #android

Smart-Rent-System

★ 27 Open GitHub ↗

Smart-Rent is a comprehensive property rental platform built with the MERN stack. It connects property owners with potential guests, creating a seamless experience for listing, discovering, and booking accommodations.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 🏡 Smart Rent System

**Revolutionizing the rental experience through technology and community**

[![SWoC 2025](https://raw.githubusercontent.com/hitesh-kumar123/Smart-Rent-System/main/assets/Project%20Admin%20Badge.png)](https://swoc.tech)
[![Contributors](https://img.shields.io/github/contributors/hitesh-kumar123/Smart-Rent-System?style=flat-square)](https://github.com/hitesh-kumar123/Smart-Rent-System/graphs/contributors)
[![Stars](https://img.shields.io/github/stars/hitesh-kumar123/Smart-Rent-System?style=flat-square)](https://github.com/hitesh-kumar123/Smart-Rent-System/stargazers)
[![Issues](https://img.shields.io/github/issues/hitesh-kumar123/Smart-Rent-System?style=flat-square)](https://github.com/hitesh-kumar123/Smart-Rent-System/issues)
[![License](https://img.shields.io/github/license/hitesh-kumar123/Smart-Rent-System?style=flat-square)](https://raw.githubusercontent.com/hitesh-kumar123/Smart-Rent-System/main/LICENSE)
[![Last Commit](https://img.shields.io/github/last-commit/hitesh-kumar123/Smart-Rent-System?style=flat-square)](https://github.com/hitesh-kumar123/Smart-Rent-System/commits)

[🚀 Live Demo](https://smartrentsystem.netlify.app/) • [📖 Documentation](#) • [🐛 Report Bug](https://github.com/hitesh-kumar123/Smart-Rent-System/issues) • [✨ Request Feature](https://github.com/hitesh-kumar123/Smart-Rent-System/issues)

</div>

---

## 📋 Table of Contents

<details open>
<summary>Click to expand</summary>

- [🎯 Vision](#-vision)
- [✨ Features](#-features)
- [🛠️ Technology Stack](#️-technology-stack)
- [📸 Screenshots](#-screenshots)
- [🚀 Quick Start](#-quick-start)
- [📚 Project Structure](#-project-structure)
- [🔧 Configuration](#-configuration)
- [🤝 Contributing](#-contributing)
- [🗺️ Roadmap](#️-roadmap)
- [👥 Community](#-community)
- [📄 License](#-license)
- [🙏 Acknowledgments](#-acknowledgments)

</details>

---

## 🎯 Vision

Smart Rent System is more than a rental platform—it's a **movement towards smarter, more transparent property transactions**. Built with modern web technologies and best practices, we're creating a space where property owners and travelers connect seamlessly.

### 🌍 Our Mission

```
Democratize property rentals by building an open-source platform that:
✓ Prioritizes user experience and security
✓ Fosters trust through verified reviews
✓ Empowers developers to learn and contribute
✓ Creates economic opportunities for hosts worldwide
```

### 🎓 Learning Hub

As part of **Social Winter of Code (SWoC) 2026**, Smart Rent System serves as a comprehensive learning resource for developers mastering the MERN stack. Dive into real-world implementations of:

- **RESTful API Design** with Express.js
- **State Management** using Redux Toolkit
- **Real-time Communication** with WebSockets
- **Cloud Storage** integration with Cloudinary
- **Authentication Flows** including OAuth 2.0
- **Database Modeling** for complex relationships

---

## ✨ Features

### 🔐 **Secure Authentication**

- JWT-based session management
- Google OAuth integration
- Password encryption with bcrypt
- Role-based access control (RBAC)

### 🏠 **Smart Listings**

- Rich media uploads (Cloudinary CDN)
- Dynamic pricing algorithms
- Amenities and house rules editor
- Availability calendar integration

### 🗺️ **Map Integration**

- Interactive Leaflet.js maps
- Geolocation-based search
- Radius filtering
- Custom map markers

</td>
<td width="50%">

### 💬 **Real-Time Chat**

- Socket.io powered messaging
- Typing indicators
- Read receipts
- Message history persistence

### 📊 **Analytics Dashboard**

- Booking statistics
- Revenue tracking
- Occupancy rates
- User engagement metrics

### ⭐ **Review System**

- Verified guest reviews
- Rating aggregation
- Photo reviews
- Response management

</td>
</tr>
</table>

---

## 🛠️ Technology Stack

### Frontend Arsenal

![React](https://img.shields.io/badge/React-18.2-61DAFB?style=for-the-badge&logo=react&logoColor=black)
![Redux](https://img.shields.io/badge/Redux_Toolkit-1.9-764ABC?style=for-the-badge&logo=redux&logoColor=white)
![TailwindCSS](https://img.shields.io/badge/Tailwind_CSS-3.3-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)
![React Router](https://img.shields.io/badge/React_Router-6.x-CA4245?style=for-the-badge&logo=react-router&logoColor=white)

### Backend Infrastructure

![Node.js](https://img.shields.io/badge/Node.js-18.x-339933?style=for-the-badge&logo=node.js&logoColor=white)
![Express](https://img.shields.io/badge/Express-4.18-000000?style=for-the-badge&logo=express&logoColor=white)
![Socket.io](https://img.shields.io/badge/Socket.io-4.5-010101?style=for-the-badge&logo=socket.io&logoColor=white)
![JWT](https://img.shields.io/badge/JWT-Auth-000000?style=for-the-badge&logo=json-web-tokens&logoColor=white)

### Database & Storage

![MongoDB](https://img.shields.io/badge/MongoDB-6.0-47A248?style=for-the-badge&logo=mongodb&logoColor=white)
![Mongoose](https://img.shields.io/badge/Mongoose-7.x-880000?style=for-the-badge&logo=mongodb&logoColor=white)
![Cloudinary](https://img.shields.io/badge/Cloudinary-CDN-3448C5?style=for-the-badge&logo=cloudinary&logoColor=white)

### Development Tools

![Git](https://img.shields.io/badge/Git-Version_Control-F05032?style=for-the-badge&logo=git&logoColor=white)
![Postman](https://img.shields.io/badge/Postman-API_Testing-FF6C37?style=for-the-badge&logo=postman&logoColor=white)
![ESLint](https://img.shields.io/badge/ESLint-Code_Quality-4B32C3?style=for-the-badge&logo=eslint&logoColor=white)
![Prettier](https://img.shields.io/badge/Prettier-Code_Format-F7B93E?style=for-the-badge&logo=prettier&logoColor=black)

</div>

---

## 📸 Screenshots

<details>
<summary>🖼️ View Application Screenshots</summary>

### Landing Page

![Landing Page](https://raw.githubusercontent.com/hitesh-kumar123/Smart-Rent-System/main/assets/Landing%20Page.png)

### Property Listings

![Property Grid](https://raw.githubusercontent.com/hitesh-kumar123/Smart-Rent-System/main/assets/Property%20Grid.png)

### Interactive Map

![Map View](https://raw.githubusercontent.com/hitesh-kumar123/Smart-Rent-System/main/assets/Map%20View.png)

### Real-Time Chat

![Chat Interface](https://raw.githubusercontent.com/hitesh-kumar123/Smart-Rent-System/main/assets/Chat%20Interface.png)

</details>

---

## 🚀 Quick Start

### Prerequisites

Before you begin, ensure you have the following installed:

```bash
node -v  # v16.0.0 or higher
npm -v   # v8.0.0 or higher
```

You'll also need:

- **MongoDB** (local installation or Atlas URI)
- **Cloudinary Account** (free tier available)
- **Git** for version control

### Installation

**1. Clone the Repository**

```bash
git clone https://github.com/hitesh-kumar123/Smart-Rent-System.git

```

**2. Backend Setup**

```bash
cd backend
npm install
```

Create `.env` file in the `backend` directory:

```env
# Server Configuration
PORT=8000
NODE_ENV=development

# Database
MONGODB_URI=mongodb://localhost:27017/smartrent

# Authentication
JWT_SECRET=your_super_secret_jwt_key_change_in_production
JWT_EXPIRE=7d

# Cloudinary Configuration
CLOUDINARY_CLOUD_NAME=your_cloud_name
CLOUDINARY_KEY=your_api_key
CLOUDINARY_SECRET=your_api_secret

# Google OAuth (Optional)
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
```

**3. Frontend Setup**

```bash
cd ../frontend
npm install
```

Create `.env` file in the `frontend` directory:

```env
REACT_APP_API_URL=http://localhost:8000/api
REACT_APP_SOCKET_URL=http://localhost:8000
```

**4. Launch Application**

**Terminal 1 - Backend:**

```bash
cd backend
npm run server
```

**Terminal 2 - Frontend:**

```bash
cd frontend
npm run dev
```

**5. Access the Application**

Open your browser and navigate to:

```
http://localhost:3000
```

🎉 **Congratulations!** Smart-Rent is now running locally.

---

## 📚 Project Structure

```
Smart-Rent/
├── backend/
│   ├── config/              # Configuration files
│   ├── controllers/         # Request handlers
│   ├── middleware/          # Custom middleware
│   ├── models/              # Mongoose schemas
│   ├── routes/              # API routes
│   ├── utils/               # Helper functions
│   └── server.js            # Entry point
│
├── frontend/
│   ├── public/              # Static assets
│   ├── src/
│   │   ├── components/      # Reusable components
│   │   ├── pages/           # Page components
│   │   ├── redux/           # State management
│   │   ├── services/        # API services
│   │   ├── utils/           # Utility functions
│   │   └── App.js           # Root component
│   └── package.json
│
├── assets/                  # Project assets
├── docs/                    # Documentation
├── .gitignore
├── CONTRIBUTING.md
├── LICENSE
└── README.md
```

---

## 🔧 Configuration

### Environment Variables Reference

| Variable                | Description                | Required | Default |
| ----------------------- | -------------------------- | -------- | ------- |
| `PORT`                  | Backend server port        | ✅       | 8000    |
| `MONGO_URL`             | MongoDB connection string  | ✅       | -       |
| `JWT_SECRET`            | Secret key for JWT signing | ✅       | -       |
| `CLOUDINARY_CLOUD_NAME` | Cloudinary cloud name      | ✅       | -       |
| `CLOUDINARY_KEY`        | Cloudinary API key         | ✅       | -       |
| `CLOUDINARY_SECRET`     | Cloudinary API secret      | ✅       | -       |

### API Documentation

Once the backend is running, access API documentation at:

```
http://localhost:8000/api-docs
```

---

## 🐳 Docker Setup (Recommended)

This project supports Docker to simplify local development, reduce setup issues, and ensure a consistent development environment across systems.

### Prerequisites

Make sure you have the following installed on your system:

- Docker (v20+ recommended)
- Docker Compose (v2+)

### Verify installation:

```bash
docker --version
docker compose version
```

### Clone the repository

```bash
git clone https://github.com/hitesh-kumar123/Smart-Rent-System.git
cd Smart-Rent-System
```

## 📁 Project Structure (Docker)

Docker uses a single `.env` file at the project root.

```
Smart-Rent-System/
├── backend/
│   └── Dockerfile         # Backend container
├── frontend/
│   └── Dockerfile         # Frontend container
├── docker-compose.yml     # Docker orchestration
├── .env                   # Required for Docker
└── README.md
```

## 🔐 Environment Variables

When using Docker, only one `.env` file is required at the `root`.

Create a `.env` file in the project `root` with the following content:

```env
# Backend
PORT=8000
NODE_ENV=development
MONGODB_URI=mongodb://mongodb:27017/smartrent
JWT_SECRET=your_jwt_secret_here

# Optional (email service)
# RESEND_API_KEY=your_resend_key_here

# Frontend
REACT_APP_API_URL=http://localhost:8000
```

### 🚀 Running the Application with Docker

From the project `root`, run:

```
docker compose up --build
```

**This will:**

- Build backend and frontend images
- Start MongoDB
- Start backend and frontend services
- Automatically link all services together

### 🌐 Accessing the Application

Once the containers are running:

**Frontend:**

```
http://localhost:3000
```

**Backend API:**

```
http://localhost:8000
```

**MongoDB:**

```
mongodb://localhost:27017
```

### 🛑 Stopping the Application

To stop and remove all containers:

```
docker compose down
```

To stop containers but keep them:

```
docker compose stop
```

### 🔄 Rebuilding Containers (After Code Changes)

If you modify dependencies or Docker files:

```
docker compose up --build
```

---

## 🤝 Contributing

We ❤️ contributions! Smart-Rent is an open-source project built for **Social Winter of Code (SWoC) 2026**.

### How to Contribute

**1. Find an Issue**

- Browse [existing issues](https://github.com/hitesh-kumar123/Smart-Rent-System/issues)
- Look for labels: `good first issue`, `help wanted`, `enhancement`

**2. Fork & Create Branch**

```bash
# Fork the repository (click Fork button on GitHub)

# Clone your fork
git clone https://github.com/hitesh-kumar123/Smart-Rent-System.git
# Create a feature branch
git checkout -b feature/amazing-feature
```

**3. Make Changes**

```bash
# Make your changes
# Follow our coding standards (ESLint + Prettier)

# Test your changes
npm test
```

**4. Commit & Push**

```bash
# Commit with descriptive message
git commit -m "Add: Implement amazing feature"

# Push to your fork
git push origin feature/amazing-feature
```

**5. Create Pull Request**

- Go to your fork on GitHub
- Click "New Pull Request"
- Fill out the PR template
- Wait for review 🎉

### Contribution Guidelines

📖 Read our [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines including:

- Code style and formatting
- Commit message conventions
- Testing requirements
- Documentation standards

### Development Workflow

```mermaid
graph LR
    A[Fork Repo] --> B[Clone Locally]
    B --> C[Create Branch]
    C --> D[Make Changes]
    D --> E[Run Tests]
    E --> F[Commit]
    F --> G[Push to Fork]
    G --> H[Create PR]
    H --> I[Code Review]
    I --> J[Merge]
```

---

## 🗺️ Roadmap

### ✅ Phase 1 - Foundation (Completed)

- [x] Project scaffolding and architecture
- [x] User authentication system
- [x] Basic CRUD operations for listings
- [x] Responsive UI with Tailwind CSS

### 🚧 Phase 2 - Core Features (In Progress)

- [x] Map integration with Leaflet.js
- [] Real-time chat with Socket.io
- [ ] Advanced search and filtering
- [ ] Booking calendar with conflict resolution
- [ ] Review and rating system

### 🔮 Phase 3 - Advanced Features (Planned)

- [ ] Payment gateway integration (Stripe/Razorpay)
- [ ] Email notifications (SendGrid/Nodemailer)
- [ ] Admin dashboard with analytics
- [ ] Multi-language support (i18n)
- [ ] Progressive Web App (PWA)

### 🌟 Phase 4 - Optimization (Future)

- [ ] Performance optimization (lazy loading, code splitting)
- [ ] SEO optimization
- [ ] Automated testing (Jest, Cypress)
- [ ] CI/CD pipeline (GitHub Actions)
- [ ] Mobile native apps (React Native)

**Want to influence the roadmap?** [Share your ideas](https://github.com/hitesh-kumar123/Smart-Rent-System/discussions)

---

## 👥 Community

### 🌟 Project Admin

<table>
  <tr>
    <td align="center">
      <a href="https://github.com/hitesh-kumar123">
        <img src="https://avatars.githubusercontent.com/u/186756045?v=4" width="120px" alt="Hitesh Kumar"/>
        <br />
        <sub><b>Hitesh Kumar</b></sub>
      </a>
      <br /><br />
      <a href="https://www.linkedin.com/in/hitesh-kumar-dev/">
        <img src="https://img.shields.io/badge/LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white" />
      </a>
    </td>
  </tr>
</table>

---

### 🏆 Top Contributors

---

### ⭐ Stargazers

---

### 🍴 Forkers

---

### ❤️ Support the Project

💙 If you like this project, consider **starring ⭐** and **forking 🍴** it to support the community!

</div>

### 💬 Join the Conversation

[![Discord](https://img.shields.io/badge/Discord-Join_Server-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.com/channels/@me)
[![Linkedin](https://img.shields.io/badge/LinkedIn-Connect-0077B6?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/hitesh-kumar-dev/)
[![GitHub](https://img.shields.io/badge/GitHub-Star_Repo-1DA1F2?style=for-the-badge&logo=github&logoColor=white)](https://github.com/hitesh-kumar123/Smart-Rent-System)

</div>

---

## 📄 License

This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.

```
MIT License - Copyright (c) 2025 Smart Rent System Contributors
Permission is hereby granted, free of charge, to any person obtaining a copy...
```

---

## 🙏 Acknowledgments

Special thanks to:

- **[Social Winter of Code 2026](https://swoc.tech)** for providing this amazing opportunity
- **Open Source Community** for continuous inspiration
- **Contributors** who dedicate their time to improve Smart-Rent
- **[Flaticon](https://www.flaticon.com/)** for icons
- **[Cloudinary](https://cloudinary.com/)** for image hosting
- **[MongoDB Atlas](https://www.mongodb.com/atlas)** for database hosting

---

### 🌟 Star History

[![Star History Chart](https://api.star-history.com/svg?repos=hitesh-kumar123/Smart-Rent-System&type=date&legend=top-left)](https://www.star-history.com/#hitesh-kumar123/Smart-Rent-System&type=date&legend=top-left)

### 📊 Repository Stats

![Repository Size](https://img.shields.io/github/repo-size/hitesh-kumar123/Smart-Rent-System?style=flat-square)
![Lines of Code](https://img.shields.io/tokei/lines/github/hitesh-kumar123/Smart-Rent-System?style=flat-square)
![Top Language](https://img.shields.io/github/languages/top/hitesh-kumar123/Smart-Rent-System?style=flat-square)

---

**Made with ❤️ by the Smart Rent System Community**

**If this project helped you, give it a ⭐️!**

[⬆ Back to Top](#-smart-rent-system)

</div>

Smart-Rent-System

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README