This is a Next.js project bootstrapped with create-next-app.

Rental System Management

A full‑stack system management platform built with Next.js. Rental System Management is designed to manage users, records, and operational workflows efficiently with a modern, scalable, and developer‑friendly architecture.

⚡ Built with performance, scalability, and real‑world system management use‑cases in mind.

---

🚀 Overview

The Rental System Management is a landlord–tenant communication and management platform built to streamline interaction, integrity, transparency, and operational control between property owners (landlords) and tenants.

At its core, Rental System Management enables secure communication, structured record management, and administrative oversight, while still supporting all general system management features such as authentication, dashboards, and data control.

The platform is designed to reduce friction in rental management by centralizing:

• Communication between landlords and tenants
• Property-related updates and notices
• Tenant records and system data

It follows modern full-stack best practices using Next.js App Router, API routes, and MongoDB (Mongoose).

---

DISCLAIMER ⚠️⚠️

Authentication in this system is about access control, not user discovery.

HOW IT WORKS

🔐 Getting Started (Admin → Tenant Flow)

1. Log in as Admin

   • Use the admin credentials provided during setup.
   • This gives you access to the main dashboard.

   ---

   ADMIN ID: Arnoldk
   PASSCODE: qwertyuiop

   ---

2. Create a Tenant

   • From the admin dashboard, create a tenant by assigning:
     • Room number
     • Login credentials
   • Save the tenant details.

3. Log in as Tenant

   • Log out from the admin account.
   • Log in using the tenant credentials you just created.
   • The tenant can now access their dashboard and interact with the system.

ℹ️ Note: Tenant accounts cannot self-register. All tenant credentials are created and managed by the admin.

---

🧠 Key Features

💬 Landlord–Tenant Communication

• Secure messaging between landlords and tenants

• Centralized communication history

• Broadcast announcements (e.g. rent reminders, maintenance notices)

🏠 Tenant & Property Management

• Tenant records management

• Property/room association

• Tenant discussion Forum

• Status tracking (active, inactive, vacated)

• Vacancy status management per property/unit

🔐 Authentication & Authorization

• Secure authentication flow

• Role-based access control (Landlord / Tenant / Admin)

• Protected routes using middleware

📊 Dashboard

• Role-based dashboards

• System summaries and activity overviews

• Rent payment insights for landlords

• Clean and responsive UI

🗂️ Data Management

• CRUD operations for tenants, properties, messages, and rent records

• MongoDB collections managed using Mongoose models

• Server-side validation

⚙️ Backend API

• Built-in API routes using Next.js

• Clean separation of Authentication, Authorization, models, and utilities

• Centralized database connection logic

• Secure endpoints for rent tracking and vacancy queries

🌐 Modern Frontend

• Next.js (App Router)

• Server Components & Client Components

• Responsive layout

• Reusable UI components

💰 Rent Payment Tracking

• Landlords can track rent payments per tenant

• Payment status indicators (Paid / Pending / Overdue)

• Historical rent records for accountability

👀 Public Vacancy Viewing

• Visitors can view available vacant rooms or properties

• No authentication required for vacancy listings

• Clear property details and availability status

---

🛠️ Tech Stack

Frontend	Backend	Database	Tooling
Next.js (App Router)	Next.js API Routes	MongoDB	Git & GitHub
TypeScript & JavaScript	Node.js runtime	Mongoose ODM	Environment variables (.env)
React	Mongoose ODM	Prisma ORM	ESLint
Tailwind CSS	Prisma ORM

---

🔗 Database Connection (Mongoose)

The system uses a single reusable MongoDB connection to prevent multiple connections during hot reloads in development.

Key points:

• Connection handled in lib/db.ts
• Cached connection for performance
• Uses environment variables for security

---

🧩 Models

Each MongoDB collection is defined using a Mongoose schema.

Example:

• User Model
• Role‑based fields
• Timestamps enabled

Models are reusable across API routes and server actions.

---

🔐 Environment Variables

Create a .env file in the root directory:

MONGODB_URI=your_mongodb_connection_string
NEXTAUTH_SECRET=your_secret_key
NEXTAUTH_URL=http://localhost:3000
JWT_SECRET=your_secret_key
ADMIN_ID=your_admin_id
ADMIN_PASSWORD=your_password

⚠️ Never commit .env.local to GitHub.

---

▶️ Getting Started

1️⃣ Clone the Repository

git clone https://github.com/nianod/Rental-management-system
cd Rental-management-system

2️⃣ Install Dependencies

npm install

3️⃣ Run Development Server

npm run dev

App runs on:

http://localhost:3000

---

🧪 API Endpoints (Example)

Method	Endpoint	Description
GET	/api/users	Fetch all users
POST	/api/users	Create new user
PUT	/api/users/:id	Update user
DELETE	/api/users/:id	Delete user

---

🧠 Design Principles

• Separation of concerns
• Scalable folder structure
• Reusable components
• Secure by default
• Production‑ready architecture

---

🚧 Future Improvements(implementation on progress)

• Real-time messaging (WebSockets)
• Rent payment tracking & reminders
• Maintenance request module
• Read receipts & message status
• File uploads (agreements, notices)
• Notifications (email / in-app)
• Audit logs

---

🤝 Contributing

Contributions are welcome!

1. Fork the repository
2. Create a new branch
3. Commit your changes
4. Open a pull request

---

📄 License

This project is licensed under the MIT License.

---

👨‍💻 Developer: Arnold

Aspiring Tech Professional | Full‑Stack Developer