Skip to content

Latest commit

 

History

History
126 lines (101 loc) · 4.86 KB

README.md

File metadata and controls

126 lines (101 loc) · 4.86 KB
Raw

Student Face Recognition System Documentation

Table of Contents

  1. Introduction
  2. Getting Started
  3. Usage
  4. Project Structure
  5. Contributing
  6. License

Introduction

The Student Face Recognition System is a Python application that allows users to manage student information and perform real-time face recognition. The application is built using Flask, OpenCV, and face_recognition library and provides features for adding, viewing, and deleting student records.

Getting Started

Prerequisites

Before you can run the Student Face Recognition System, ensure you have the following prerequisites installed:

  • Python 3.x
  • Flask
  • Flask-WTF
  • OpenCV (cv2)
  • face_recognition library

Environment Setup

Before running the Student Face Recognition project, it's essential to set up a Python environment and install the required dependencies. You can follow these steps to get your environment ready:

  1. Create a Virtual Environment (Optional): It's a good practice to create a virtual environment to isolate project dependencies. If you don't have virtualenv installed, you can install it using pip:

    pip install virtualenv

    Then, create a virtual environment for the project:

    virtualenv venv

    Activate the virtual environment:

    • On Windows:

      venv\Scripts\activate

    • On macOS and Linux:

      source venv/bin/activate

  2. Clone the Project Repository: You'll need to clone the project's GitHub repository to your local machine. If you haven't already cloned it, you can do so with the following command:

    git clone https://github.com/your_username/student-face-recognition.git

  3. Navigate to the Project Directory: Change your working directory to the project folder:

    cd student-face-recognition

  4. Install Dependencies: Additionally, you may need to install the dlib library using a specific Wheel file. If necessary, you can install dlib using the provided Wheel file with the following command:

    pip install dlib-19.22.99-cp39-cp39-win_amd64.whl

    To install the required Python libraries, you can use the provided requirements.txt file. Run the following command to install them:

    pip install -r requirements.txt

With these steps, you'll have a clean and isolated environment for your Student Face Recognition project with all the necessary dependencies installed.

Usage

Adding Students

  1. Run the application by executing app.py.

    python app.py

  2. Access the web interface via a web browser (e.g., http://localhost:8000).

    • Click on the "Add Student" link.
    • Fill in the student's information, including Student ID, Name, Roll No, and Class.
    • Upload a photo of the student.
    • Click the "Add Student" button to save the student's information.

Live Face Recognition

  • Click on the "Live Page" link to access the live face recognition page.
  • The application will automatically detect and recognize faces from your webcam feed.
  • Recognized students' names will be displayed in the video frame.

Viewing Students

  • Click on the "View Students" link to see the list of added students.
  • The students' details, including Student ID, Name, Roll No, Class, and photos, will be displayed.

Deleting Students

  • In the "View Students" page, each student's entry will have a "Delete" button.
  • Click the "Delete" button to remove a student from the database.
  • The student's photo will also be deleted from the media folder.

Project Structure

  • app.py: The main application script.
  • templates/: HTML templates used for rendering web pages.
  • media/: Directory to store uploaded student photos.
  • known_faces/: Directory to store known faces for face recognition.
  • requirements.txt: Lists the required Python packages.

Contributing

Contributions to this project are welcome. To contribute, follow these steps:

  1. Fork the repository on GitHub.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and test them.
  4. Create a pull request to the original repository.

License

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

Feel free to customize and expand this documentation to fit your project's specific needs. Documenting your project helps both users and potential contributors understand and engage with your work more effectively.