🏠 PGHunter.in – Complete Platform

PGHunter.in is a modern PG accommodation discovery platform with an Admin Dashboard and Backend API.
It enables users to search, explore, and book PGs, while admins can seamlessly manage properties and listings.

---

📖 About PGHunter.in

PGHunter.in was born from a simple idea:
👉 To make finding the perfect off-campus housing near LPU (Lovely Professional University) a seamless and stress-free experience.

We are a team of passionate professionals (and proud LPU alumni ✨) who know firsthand the challenges students face while searching for safe and comfortable accommodation.

Our platform connects students with verified, high-quality PGs and apartments, ensuring safety, comfort, and convenience.
We’re more than just a listing service — we’re your trusted partner in your academic journey.

---

🌟 What We Do

• 🏠 Curated Listings → Every property is vetted for safety, hygiene & amenities.
• ⚡ Seamless Booking → Filter, compare, and book with transparent pricing.
• 🎓 Student Support → Ongoing help even after booking, including maintenance & community support.

---

🎯 Why Choose PGHunter?

✅ 100% Verified Properties – No fake or misleading listings
✅ Student-Centric Amenities – Wi-Fi, study zones, security, proximity to campus
✅ Vibrant Community – Connect with fellow students through events & features
✅ Transparent Pricing – No hidden charges, no surprises

📩 Contact Us: contact.pghunter@gmail.com
📞 +91 97747 28561

---

👨‍👩‍👦 Meet Our Team

• Aditya Kumar – Founder & CEO
• Tanmoy Debnath – Founder & CTO
• Karanjeet Kumar – Founder & Head of Operations
• Rohit Kumar – Backend Engineer
• Aman Kumar – Marketing Director

---

✨ Features

👤 User Features (PGHunter.in)

• 🏡 Landing page showcasing PGHunter services
• 📋 Browse PG listings with smart filters
• 🔍 Quick search functionality
• 📖 Detailed PG pages with pricing & amenities
• 📑 About Us & Contact Us pages
• 🔐 Modal-based authentication
• 🎠 Slick Carousel-based interactive sliders
• ⬆️ Auto scroll-to-top on navigation

🔑 Admin Features (pgAdmin)

• 🔐 JWT + Cookie-based authentication
• 🏠 Add, update, and manage PG listings
• 📸 Upload multiple property images
• ⭐ Mark PGs as featured, sold out, or unpublished
• 🛠 Manage amenities, house rules, contact info
• 🎨 Responsive UI with TailwindCSS

⚡ Backend API Features (Node.js + Express)

• 👤 JWT + Cookie-based authentication
• 🏠 PG CRUD APIs
• 📩 Contact Us form with Nodemailer integration
• 📂 Secure file uploads via express-fileupload
• 🔒 Role-based access (User & Admin)

---

🛠 Tech Stack

• Frontend (PGHunter.in): React.js, CSS, Slick Carousel, React Router v6
• Admin Dashboard (pgAdmin): React.js (Vite), TailwindCSS, Context API, Lucide Icons, Axios
• Backend (API): Node.js, Express.js, MongoDB, JWT, Cookies, Nodemailer, express-fileupload

---

📂 Project Structure

PGHunter/
│── frontend/ (PGHunter.in - User Website)
│   ├── src/
│   │   ├── components/   # Header, Footer, LoginModal, ScrollToTop
│   │   ├── pages/        # Homepage, Listings, PGDetails, About, ContactUs
│   │   ├── App.js
│   │   └── index.js
│   └── public/

│── admin/ (pgAdmin - Admin Dashboard)
│   ├── src/
│   │   ├── components/   # PrivateRoute, HomeRedirect, TakeImage
│   │   ├── context/      # AuthContext
│   │   ├── pages/        # Dashboard, AddPG, Login, Signup
│   │   ├── App.jsx
│   │   └── main.jsx
│   └── public/

│── backend/ (pghunter-backend - API Server)
│   ├── src/
│   │   ├── config/       # database.js
│   │   ├── controllers/  # auth-controller.js, pg-controllers.js
│   │   ├── middlewares/  # auth-middleware.js
│   │   ├── routes/       # authRoutes.js, pgRoutes.js
│   │   └── utils/        # emailHelpers.js
│   ├── server.js
│   └── .env

└── README.md

---

⚡ Installation & Setup

1️⃣ Clone the Repository

git clone https://github.com/your-username/pghunter.git
cd pghunter

---

🏡 Setup PGHunter Frontend (User Website)

cd frontend
npm install
npm start

Runs on → http://localhost:3000/

---

🛠️ Setup pgAdmin (Admin Dashboard)

cd admin
npm install
npm run dev

Runs on → http://localhost:5173/

Create .env in admin/:

VITE_API_BASE_URL=http://localhost:4000

---

⚙️ Setup Backend API

cd backend
npm install
npm run dev

Backend runs on → http://localhost:4000/

Create .env in backend/:

PORT=4000
MONGODB_URI=your-mongodb-uri
JWT_SECRET=your-secret-key
EMAIL_USER=your-email@example.com
EMAIL_PASS=your-email-password

---

📡 API Endpoints

🔑 Auth (/api/v1/auth)

• POST /register → Register user
• POST /login → Login & set cookie
• GET /checkAdmin → Verify admin

🏠 PG (/api/v1/pg)

• POST /createpg → Create new PG
• GET /allpg → Get all PGs
• GET /admin/allpg → Admin-only PGs
• GET /byid/:id → Get PG by ID
• PATCH /update → Update PG
• POST /upload/img → Upload images

📩 Contact (/api/v1/contactus)

• POST → Send message (email notification)

---

📸 Screenshots

🏡 Home Page

⭐ Featured PGs

📋 All PG Listings

(Admin dashboard screenshots coming soon ✅)

---

🌐 Deployment

• Frontend & Admin → Vercel / Netlify
• Backend → Render / Railway / AWS / DigitalOcean

Build before deployment:

npm run build

---

👨‍💻 Authors

• Tanmoy Debnath
  📧 [your-email@example.com]
  🔗 Portfolio / LinkedIn

• Rohit Kumar
  📧 rohitranjanrrsingh@gmail.com
  🔗 Portfolio / LinkedIn

---

📜 License

This project is licensed under the MIT License.
Feel free to use, modify, and distribute with attribution.

---