Code Monkey home page Code Monkey logo

hostel-e-attendance's Introduction

Hostel-E-attendance

Description:

Designed a simple website integrated into the ML model for tracking the attendance of the hostellers.

Tech Stack Used:

  1. MERN Stack
  2. Face API

Flow Chart of the Project:

Web Dev Project-Students Flow

Running the project locally:

  • Clone the repository:
git clone https://github.com/tansexe/Hostel-E-attendance.git
  • Install dependencies:
cd Hostel-E-attendance
npm install
  • Start the server:
npm start

The server will listen on port 3000 by default.

After Cloning, the Explorer will have these folders:

  1. Backend-E-Attendance
  2. Face-Detection
  3. Frontend-Vite

Frontend Documentation:

The Frontend-Vite folder contains the folder for the frontend.

At the heart of the Frontend-Vite folder is the src folder. Within this folder, several subfolders have important roles:

  1. Assets: This folder houses all the images utilized in the project.
  2. Components: This folder includes reusable elements such as buttons, navigation bars, and headers.
  3. Pages: This folder encompasses all the web pages of the website.

Additionally, App.jsx enlists the components to be rendered from different routes. For the routing of pages in React, React-Router-Dom, a third-party library, is integrated.

Backend Documentation:

The Backend-E-attendance folder contains the folder for the backend.

Routing Guide

This project has the following endpoints:

User

Methods Route Description Request Response
GET /users/getAllUsers To get the info of all users. _id, Username, RollNo, Hostel, Email, Password, Phone All the User details are sent.
POST /users/Signup Registering all the users Username, RollNo, Hostel, Email, Password, Phone success: True/False
POST /users/Login Logging all the users email, password, Username message: User found or not

Screenshots

Home Page

image

Register Page

image

Login Page

image

Face Detection Model

image

Troubleshooting

If you encounter any issues while using the Hostel-E-attendance, consider the following troubleshooting steps:

  1. Check Dependencies: Ensure you have installed all required dependencies.
  2. Review Error Messages: If you encounter any errors, carefully review the error messages to identify the source of the issue.

References

  1. JavaScript API for Face Recognition in the Browser with tensorflow.js. Link
  2. Github Repository of faceAPI.js. Link
  3. Github Repository of face Detection. Link

hostel-e-attendance's People

Contributors

tansexe avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.