V1.0

Hosteller's Sahayyak

A Comprehensive Solution for Hostel Management Challenges

---

🚀 Overview

"Hosteller's Sahayyak" is a robust project aimed at improving the experience of hostelers by addressing two critical needs:

1. A Grievance System for raising, tracking, and resolving issues related to hostel facilities.
2. A Self-Biometric Attendance System leveraging advanced face recognition and location-based validation.

This project introduces role-based login for hostellers (students), rectors, and higher authorities to ensure smooth operations, streamlined communication, and actionable insights for hostel management.

---

🛠️ Features

1️⃣ Role-Based Login

• Hosteller (Student): Raise complaints, view attendance, and track grievance resolutions.
• Rector: Manage complaints, track student attendance, and oversee hostel operations.
• Higher Authority: Access analytical dashboards and overall hostel data for informed decisions.

2️⃣ Grievance Management System

• Formal platform for reporting issues related to:
  • Mess/tiffin quality
  • Hostel cleanliness
  • Facility maintenance
  • Wi-Fi connectivity
• Efficient tracking and resolution system.

3️⃣ Self-Biometric Attendance System

• Face Recognition: Ensures accurate attendance tracking.
• Location Validation: Attendance is only valid within a specific range of the hostel premises.

4️⃣ Admin Panel

• Powerful dashboards with advanced analytics for rectors and higher authorities to monitor operations and make data-driven decisions.

5️⃣ Developer Dashboard

• Comprehensive dashboard for Developer with data visualizations and reports.

---

💻 Technology Stack

Technology	Details
Frontend	Next.js 14, React + Vite, TailwindCSS
Backend	Express.js, MongoDB
Languages	TypeScript, JavaScript
Security	OWASP Top 10 Compliant RESTful APIs

---

📊 Key Benefits

1. Empowers Students: Provides a voice to raise concerns and ensures timely resolutions.
2. Improves Efficiency: Streamlines attendance and feedback mechanisms.
3. Secure & Reliable: Advanced biometric verification combined with location-based attendance tracking.

---

📂 Project Structure

├── client/                # Frontend  
│   ├── components/        # React components  
│   ├── pages/             # Next.js / React.jspages  
│   └── styles/            # TailwindCSS styles  
├── server/                # Backend  
│   ├── controllers/       # Business logic  
│   ├── routes/            # API endpoints  
│   ├── models/            # MongoDB schemas  
│   ├── middleware/        # Security middleware  
|   └── server.js 
└── README.md              # Project documentation  
``

---
## 🚀 Getting Started

### Prerequisites
- Node.js (v18 or higher)
- MongoDB

### Installation

1. Clone the repository:
   ```bash
   git clone https://github.com/ByteNinjaSmit/Hostellers-Sahayyak-Express.git

2. Navigate to the project directory:

   cd hostellers-sahayyak

3. Install dependencies for frontend

   cd client && npm install

4. Set up environment variables:

   • Create a .env file in the client directory.
   • Add the following variables:

     VITE_APP_URI_API=http://localhost:5000

5. Run the development server:

   npm run dev

6. Install dependencies for Backend

   cd server && npm install

7. Set up environment variables:

   • Create a .env file in the server directory.
   • Add the following variables:

     PORT=5000
     CORS_SERVER=http://localhost:5173
     MONGODB_URI=mongodb+srv://username:passwordcluster0.wvrn3hd.mongodb.net/
     JWT_SECRET_KEY=projectsecret
     DEVELOPER_NAME=zodiac
     DEVELOPER_USERNAME=devlopername
     DEVELOPER_EMAIL=abcd@email.com
     DEVELOPER_PASSWORD=Pass@1234

8. Run the development server:

   npm start
   or
   npx nodemon server.js

---

🛠️ Deployment

• Build the frontend:

  cd client
  npm run build

• Build the backend:

  cd server
  npm start

• Deploy the backend to your preferred server (e.g., Heroku, AWS, VPS, etc.).

---

🤝 Contributing

We welcome contributions! Follow these steps to contribute:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-name

3. Commit your changes:

   git commit -m 'Add some feature'

4. Push to the branch:

   git push origin feature-name

5. Create a pull request.

---

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

---

🙌 Acknowledgments

• Special thanks to our mentors and peers for their guidance.
• Tools and frameworks that made this project possible: Next.js, React.js,React + Vite, Express.js, MongoDB, TailwindCSS.

---

📬 Contact

For any queries, feel free to contact:

• Smitraj Bankar
• Email: smitrajbankar11@gmail.com
• GitHub: @ByteNinjaSmit

---

#MERNstack #NextJS #TypeScript #TailwindCSS #BiometricAttendance #GrievanceSystem #OpenSource