Skip to content

A platform designed to help students retrieve lost items efficiently. This system streamlines the process of managing lost and found items, significantly reducing the need for physical office visits.

Notifications You must be signed in to change notification settings

DhavalDudheliya/LoastAndFound

Repository files navigation

Lost and Found Helper System for University 🚀

Project Duration 🗓️: January 2023 – March 2023

Project Description 📃: A platform designed to help students retrieve lost items efficiently, using Google authentication and email notifications. This system streamlines the process of managing lost and found items, significantly reducing the need for physical office visits.


Table of Contents 📋

  1. About the Project
  2. Tech Stack
  3. Features
  4. Installation
  5. Contact

About the Project ⓘ

Overview

he Lost and Found Helper System is a university platform that allows students to retrieve lost items with ease. Through Google authentication and email notifications, the system reduces the need for students to visit the office physically. It also features an admin and coordinator portal for efficient management of users and items, including CSV report generation.

Tech Stack 🚀📋

  • Frontend: React, MUI
  • Backend: Node.js, Express.js
  • Database: MongoDB, Mongoose
  • Authentication: passport-google-oauth2.0
  • Email Notifications: Nodemailer
  • Version Control: Git, GitHub

Features 📱🖥️

  • Google Authentication: Provides secure login for students using their university Google accounts.
  • Item Status Management: Tracks the status of lost items, reducing the need for physical office visits.
  • Admin & Coordinator Portal: Manages users and items, including the ability to generate CSV reports.
  • Email Notifications: Sends email updates to students about the status of their lost items.
  • Report Generation: Allows admins to generate CSV reports for better tracking and management.

Installation

Prerequisites

  • Node.js (version)
  • MongoDB (local or cloud setup)
  • npm or yarn

Setup ⚙️

  1. Clone the repository:
    git clone https://github.com/DhavalDudheliya/Hostel_Management.git
    cd Hostel_Management
    
  2. Install dependencies:
    # Install server dependencies
    cd backend
    npm install
    
    # Install client dependencies
    cd ../frontend
    npm install
    
  3. Set up environment variables:

    Backend

NODE_ENV = devlopment PORT = 8000 MONGO_URI =mongodb+srv://db:db@cluster0.4seeh3x.mongodb.net/?retryWrites=true&w=majority JWT_SECRET = abc123 CLIENT_ID =60617337648-f007rku04g1fiiru5gcn2pi8nu8g0r4d.apps.googleusercontent.com CLIENT_SECRET = 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 callbackURL = http://localhost:8000/auth/google/callback

cookieKey = Jayswaminarayan

BASE_URL = http://localhost:3000/ SERVICE = gmail EMAIL_PORT = 587 SECURE = true

USER = fromlostandfoundhelper@gmail.com USER_PASS = oaxrtmaieubzbgiz

ADMIN_USER = lostandfoundhelper@gmail.com ADMIN_PASS = dhavalmanan

  1. Run the project:
    # Run the backend
    cd backend
    npm run server
    
    # Run the frontend
    cd ../frontend
    npm run start
    

Contact 📩📞

About

A platform designed to help students retrieve lost items efficiently. This system streamlines the process of managing lost and found items, significantly reducing the need for physical office visits.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published