adityamote2205 / VJTI-Hostel-Mate

VJTI Hostel Mate is a Hostel grievance resolution portal for student . It bridges between student and hostel authorities.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

VJTI Hostel-Mate

Logo

VJTI Hostel-Mate is a web application designed to streamline communication between VJTI hostel students and rectors for addressing mess and hostel-related issues. It facilitates the submission of complaints by students and their resolution by rectors, ensuring a transparent and efficient process.

Features

  • User Authentication : Students and rectors can sign up and log in securely using JWT authentication.
  • Differentiated Profiles : Separate profiles for rectors and students to provide tailored experiences.
  • Transparency : Complaints include timestamps indicating when they were created by students and resolved by rectors.
  • Image Sharing : Students can attach images as proof when submitting complaints.
  • Complaint Management : Students can delete complaints before rectors mark them as completed if necessary.
  • About Us : Information about the project and the team behind it.
  • Contact Us : Easily accessible contact information for reaching out to the administrators.

Technology Stack

VJTI Hostel-Mate is built using the PERN stack:

  • PostgreSQL : For the database to store user information, complaints, and other relevant data.

  • Express.js : A web application framework for building APIs to handle server-side logic.

  • React.js : A JavaScript library for building user interfaces, providing a responsive and interactive frontend.

  • Node.js : A runtime environment for executing JavaScript code on the server side.

  • Postman : For testing API endpoints and ensuring smooth communication between frontend and backend.

  • JWT (JSON Web Tokens) : For secure authentication by generating and verifying tokens between the frontend and backend.

  • Bootstrap : For streamlined and visually appealing frontend design, enhancing user experience and interface aesthetics.

Website Overview & Features

  • Student's Portal for Grievance resolution : The student portal enables registered users to submit grievances concerning hostel and mess facilities, ensuring privacy by restricting hostel grievances to respective block rectors and allowing all rectors to view mess grievances. Students can update their profiles, track grievance status including pending, completed, and total, and add descriptions and images as proof for each grievance. The system facilitates efficient grievance management by authorities, offers deletion options for students before completion, and ensures security, privacy, accessibility, and usability throughout the platform.

    Student.Portal.online-video-cutter.com.mp4

6a42fa8a8

  • Rector's Dasboard : The rector's dashboard facilitates signup/login for rectors, granting access to view grievances submitted by students within their block for hostel issues and all mess grievances, including photos submitted by students as proof. Rectors can discern details such as submission date, room number, and student identity for each grievance. Upon resolving a grievance, rectors can mark it as completed, reflecting the status change on the student's account. Additionally, rectors can filter grievances by type for efficient management. The dashboard includes a profile section where rectors can monitor their workload, such as the number of complaints received, pending, and completed, and update their profile information as necessary.

    Rector.Dashboard.mp4
  • Reflection of completion of grievance on student's account : After review and resolution by the rector, when a grievance is marked as completed, the status is automatically updated on the student's account, indicating the date and time of completion. This seamless process ensures that students are promptly informed about the resolution of their grievances.

    After.Grievance.completion.from.rector.side.how.it.appears.on.student.portal.mp4

Schema Diagram

  • The schema consists of four tables: Student, Rector, Hostel Complaint, and Mess Complaint. Both complaint tables have a foreign key student_id referencing the Student table. This setup allows efficient tracking of grievances submitted by students, while the Rector table stores information about rectors overseeing the grievances.

    ER Diagram Final VJTI Hostel Mate

Getting Started

To run the Hostel Grievance Redressal System locally:

  1. Clone the repository

    git clone https://github.com/adityamote2205/VJTI-Hostel-Mate.git

  2. Navigate to the project directory :

    cd [project_directory]

  3. Install dependencies :

    npm install

  4. Configure the database :

    • Set up PostgreSQL and update the database configuration.
    • Change .env file according to your setup.
  5. Run the application :

    Start the frontend and backend servers in separate terminal windows.

    • In the frontend directory

      npm start

    • In the backend directory

      nodemon index.js

  6. Visit http://localhost:3000 to view the application in your browser.

Future Improvements

  • Edit Complaint Before Completion :

    Allowing students to edit their complaints before rectors mark them as completed adds flexibility and ensures accurate information. Implement a feature where students can make changes to their complaint details, such as the description or attached images, until it's marked as resolved by the rector.

  • Notification System :

    The system notifies rectors instantly upon new complaints within their hostel blocks, facilitating swift response. Additionally, students receive notifications upon completion of their complaints, ensuring they stay updated on grievance status for effective communication and resolution.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

Contact

For any inquiries or feedback, please contact us at vjti.hostel.mate@gmail.com

About

VJTI Hostel Mate is a Hostel grievance resolution portal for student . It bridges between student and hostel authorities.


Languages

Language:JavaScript 95.6%Language:CSS 3.6%Language:HTML 0.8%