Face-to-Face Attendance and Departure System

Overview

This repository contains a complete face-to-face attendance and departure system that uses facial recognition technology to track employee attendance. The system provides a modern, secure, and efficient way to manage employee attendance without the need for physical cards or manual sign-in sheets.

Features

• Facial Recognition: Employees can check in and out using their face
• Real-time Tracking: Administrators can view attendance status in real-time
• Comprehensive Reporting: Generate daily, weekly, monthly, and custom reports
• Employee Management: Add, edit, and manage employee information
• Role-based Access Control: Different access levels for administrators, managers, and employees
• Customizable Settings: Configure work hours, late thresholds, and other system parameters

Repository Structure

attendance_system/
├── frontend/               # Frontend code
│   ├── css/                # CSS stylesheets
│   ├── js/                 # JavaScript files
│   ├── images/             # Static images
│   └── index.html          # Main HTML file
│
├── backend/                # Backend code
│   ├── config/             # Configuration files
│   ├── controllers/        # API controllers
│   ├── middleware/         # Express middleware
│   ├── models/             # Mongoose models
│   ├── routes/             # API routes
│   ├── services/           # Business logic services
│   ├── utils/              # Utility functions
│   ├── tests/              # Test files
│   └── server.js           # Entry point
│
├── models/                 # Face recognition models
│
├── docs/                   # Documentation
│   ├── user_manual.md      # User manual
│   ├── installation_guide.md # Installation guide
│   ├── api_documentation.md # API documentation
│   └── developer_guide.md  # Developer guide
│
├── logs/                   # Log files
│
├── .env.example            # Example environment variables
├── .gitignore              # Git ignore file
├── package.json            # npm package file
└── README.md               # This file

Quick Start

Prerequisites

• Node.js (v14.0.0 or higher)
• MongoDB (v4.4 or higher)
• Modern web browser with webcam support

Installation

1. Clone the repository:

   git clone https://github.com/your-organization/face-attendance-system.git
   cd face-attendance-system
   

2. Install dependencies:

   npm install
   

3. Configure environment variables:

   cp .env.example .env
   # Edit .env file with your configuration
   

4. Start the server:

   npm start
   

5. Access the application:

   http://localhost:5000
   

For detailed installation instructions, please refer to the Installation Guide.

Documentation

• User Manual: Guide for end-users
• Installation Guide: Deployment instructions
• API Documentation: API reference
• Developer Guide: Technical documentation for developers

Technologies Used

• Frontend: HTML, CSS, JavaScript
• Backend: Node.js, Express.js
• Database: MongoDB
• Face Recognition: face-api.js
• Authentication: JWT

License

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

Acknowledgements

• face-api.js for facial recognition
• Express.js for the web framework
• MongoDB for the database
• All other open-source libraries used in this project