🏨 HostelHub – Smart Hostel Management App

Your ultimate sidekick for stress-free hostel adventures!

📖 Table of Contents

• About the Project
• Problem & Solution
• Key Features
• Tech Stack
• Demo
• Screenshots
• Environment Variables
• Installation
• Folder Structure
• Documentation & Policy
• Roadmap
• Author

---

🚀 About the Project

HostelHub is a mobile application designed to digitize hostel administration. It bridges the communication gap between students and wardens by enabling transparency, speed, and better management of daily hostel activities.

From applying for leaves to checking the mess menu or filing a complaint, HostelHub brings everything to your fingertips.

---

🧩 Problem & Solution

🔴 The Problem

Traditional hostel management relies on manual registers, paper forms, and verbal communication. This leads to:

• Slow approval processes for leaves.
• Lack of transparency in complaints.
• Inefficient communication of notices.
• No centralized feedback system for food quality.

🟢 The Solution

HostelHub digitizes these processes:

• Instant Leaves: QR-based digital passes approved in seconds.
• Trackable Complaints: Status updates ensure accountability.
• Digital Notices: Push notifications for instant reach.
• Data-Driven Mess: Feedback analytics to improve food quality.

---

🌟 Key Features

• 🏙️ Role-based Dashboard: Distinct interfaces for Student (Resident) and Warden (Admin).
• 🎟️ QR-based Digital Leave Pass: Apply online; get a time-bound QR code scanned at the gate.
• 🍛 Smart Mess Menu: View daily meals and provide 1-tap feedback with analytics.
• 🛠️ Complaint Tracking: Upload images of issues, provide descriptions, and track resolution status.
• 🛒 Hostel Marketplace: Buy and sell books, gadgets, and essentials within the hostel community.
• 📊 Polls & Voting: participate in democratic decision-making for hostel events/rules.
• 📢 Real-time Notifications: Never miss an important notice or announcement.
• 🔍 Lost & Found Board: Post and find lost items easily.

---

🛠 Tech Stack

---

🎥 Watch Live Demo

👉 https://youtu.be/3d4AHw-Zgcc

---

📱 Screenshots

Login Screen	Student Dashboard	Dashboard

Mess Menu	Complaints	Marketplace

---

🔑 Environment Configuration

Create a .env.local file in both backend and frontend directories.

Backend (/backend/.env.local)

Variable	Description	Required	Reference Value
PORT	Server Port	No	5000
DATABASE_URL	MySQL Connection String	Yes	mysql://user:pass@host:3306/db
HOSTELHUB_SECRET_JWT	Secret Key for JWT	Yes	your_secret_key

Frontend (/frontend/.env.local)

Variable	Description	Value
EXPO_PUBLIC_API_URL	Backend API URL	http://localhost:5000/api

---

⚡ Installation & Quick Start

1. Clone the Repository

git clone https://github.com/<MY_USERNAME>/HostelHub.git
cd HostelHub

2. Backend Setup

cd backend
npm install
npx prisma generate
npx prisma db push # or migrate
npm start

3. Frontend Setup

cd frontend
npm install
npm start

---

📂 Folder Structure

HostelHub/
├── backend/
│   ├── prisma/             # Database Schema
│   ├── src/
│   │   ├── config/         # Configs (Env, DB)
│   │   ├── controllers/    # Route Logic
│   │   ├── middlewares/    # Auth & Error middlewares
│   │   ├── routes/         # API Routes
│   │   ├── services/       # Business Logic
│   │   └── app.js          # Entry Point
│   └── package.json
│
├── frontend/
│   ├── assets/             # Images & Fonts
│   ├── src/
│   │   ├── api/            # API Client
│   │   ├── components/     # Reusable Components
│   │   ├── context/        # Auth & State Context
│   │   ├── navigation/     # Navigators (Stacks/Tabs)
│   │   ├── screens/        # App Screens
│   │   └── utils/          # Helpers
│   └── package.json
│
└── README.md

---

📜 Documentation & Policy

Please read the following documents to understand the development standards and project policies:

• Contributing Guidelines 🤝
• Code of Conduct 👮
• Security Policy 🛡️
• License ⚖️

---

🔮 Future Scope / Roadmap

• Payment Gateway: Integration for mess fees and rent payments.
• AI Analytics: Predictive analysis for mess food wastage and demand.
• Biometric Auth: Fingerprint/FaceID login support.
• Multi-Hostel Support: Scalable architecture for university-wide deployment.
• Offline Mode: Local caching for viewing recent notices without internet.

---

👤 Author

Krit Garg