🏠 PG Management System

The PG Management System is a full-featured web application designed to simplify and automate the management of paying guest accommodations. It provides a platform for PG Owners (Admins) and Tenants to manage room assignments, rent payments, food menus, maintenance requests, and notifications seamlessly.

📌 Table of Contents

• Features
• Tech Stack
• Getting Started
• Project Structure
• License
• Author

✨ Features

🔑 Admin Features

• View all rooms with occupancy status
• Add, edit, and delete rooms and tenant details
• Track rent payments and overdue status
• Send notifications to tenants (food, maintenance, rent reminders)
• Manage food menus with images (breakfast, lunch, dinner)
• View tenant rent history and generate reports
• Mark rent as paid and clear overdue status
• Generate downloadable rent and tenant reports in PDF

👤 Tenant Features

• View assigned room and rent status
• Access daily or weekly food menus with images
• Receive important notifications from admin
• Pay rent via the app (if payment gateway is integrated)
• Submit maintenance requests and queries
• View personal rent payment history

⚙️ How it Works

1. Admin logs in and manages rooms, tenants, rent, and food menus.
2. Tenants log in to view their assigned rooms, food menus, and notifications.
3. Angular frontend communicates with Spring Boot backend using REST APIs.
4. Backend interacts with MySQL database (hosted on Clever Cloud) for data persistence.
5. JWT-based authentication secures all API endpoints.

🛠 Tech Stack

Layer	Technology
Frontend	Angular
Backend	Spring Boot (Java)
Database	MySQL
PDF Generator	iText
Authentication	JWT
Deployment	Render

🚀 Getting Started

Backend Setup (Spring Boot)

1. Clone the repo and navigate to the backend folder:

   git clone https://github.com/your-username/pg-management-system.git
   cd pg-management-system/backend
   
   

2. Create a MySQL database:

   CREATE DATABASE pg_management;
   

3. Open src/main/resources/application.properties and update your MySQL credentials:

   spring.datasource.url=jdbc:mysql://localhost:3306/pg_management
   spring.datasource.username=your_mysql_username
   spring.datasource.password=your_mysql_password
   spring.jpa.hibernate.ddl-auto=update
   

4. Run the Spring Boot server:

   mvn spring-boot:run
   

5. Backend will be running at: http://www.staymanage.in

Frontend Setup (Angular)

1. Navigate to the frontend folder:

   cd ../frontend
   

2. Install dependencies:

   npm install
   

3. Run the Angular app:

   ng serve
   

4. Frontend will be running at: http://www.staymanage.in

📁 Project Structure

     pg-management-system/
     ├── backend/
     │   ├── src/main/java/... (Spring Boot code)
     │   └── src/main/resources/application.properties
     ├── frontend/
     │   ├── src/app/... (Angular components)
     │   └── angular.json
     └── README.md

📄 License

This project is licensed under the MIT License.

👨‍💻 Author

Sameer Nadaf LinkedIn

🌐 Live Demo

• Live link

🚧 Future Enhancements

• Online rent payment integration (Stripe/PayPal)
• SMS/WhatsApp notifications for tenants
• Analytics dashboard for admins
• Multi-PG owner support

You can copy this whole thing as one README.md file for your repo. Let me know if you want me to help create the file for you!