Hostellers Sahayyak is an innovative project designed to improve the hostel experience for students by addressing two key challenges: efficient grievance resolution and seamless attendance management. With advanced features like biometric attendance and a robust grievance system, this platform bridges the gap between students and hostel management, ensuring a better living environment for hostellers.
- Students (Hostellers): Raise grievances, track resolution status, and view attendance records.
- Rector: Manage grievances, oversee attendance, and analyze performance through dashboards.
- Higher Authorities: Gain insights into hostel operations with advanced analytics.
- Raise, track, and resolve complaints related to:
- Tiffin and mess services
- Cleanliness
- Wi-Fi and other facilities
- Transparent status updates and resolution tracking.
- Face Recognition: Reliable and secure attendance.
- Location-Based Validation: Ensures students are within a specified range.
- Comprehensive dashboard for rectors and higher authorities with data visualizations and reports.
- Comprehensive dashboard for rectors and higher authorities with data visualizations and reports.
- TypeScript
- JavaScript
- Secure APIs compliant with OWASP Top 10.
├── client
├── components
| ├──layout
├── pages
| ├── client
| ├── admin
| ├── dev
├── styles
├── server
├── controllers
├── middlewares
├── models
├── lib
├── routes
└── server.js
- Node.js (v18 or higher)
- MongoDB
-
Clone the repository:
git clone https://github.com/ByteNinjaSmit/Hostellers-Sahayyak-Express.git
-
Navigate to the project directory:
cd hostellers-sahayyak -
Install dependencies for frontend
cd client && npm install
-
Set up environment variables:
- Create a
.envfile in the client directory. - Add the following variables:
VITE_APP_URI_API=http://localhost:5000
- Create a
-
Run the development server:
npm run dev
-
Install dependencies for Backend
cd server && npm install
-
Set up environment variables:
- Create a
.envfile 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
- Create a
-
Run the development server:
npm start or npx nodemon server.js
-
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.).
We welcome contributions! Follow these steps to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature-name
- Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin feature-name
- Create a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
- 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.
For any queries, feel free to contact:
- Smitraj Bankar
- Email: smitrajbankar11@gmail.com
- GitHub: @ByteNinjaSmit
#MERNstack #NextJS #TypeScript #TailwindCSS #BiometricAttendance #GrievanceSystem #OpenSource