Skip to content

Latest commit

 

History

History
103 lines (87 loc) · 2.96 KB

README.md

File metadata and controls

103 lines (87 loc) · 2.96 KB

Face Attendance App

Demo Video

The project was build for Microsoft Engage Program 2022. This is a Face Attendance App that uses face recognition for marking students' attendance.

Features :-

  • There are two types of users i.e. Teachers and Students.
  • Students have to submit the picture of thir face during signup.
  • The information of the face corresponding to a student is stored in the form of face encodings.
  • To mark the attendance, the student has to scan his face using a teacher's device.
  • The face encoding from the scanned face and stored encoding are then compared.
  • On successful matching, the student's attendance is marked for the day.
  • The teacher can view the attendance of all the students.
  • The students can view their attendance.

Addition Information
The API for comparing faces is build using face_recognition python library.

Table of Contents

Getting Started

Prerequisites

Installation

  1. Clone the repository

    git clone https://github.com/VishalZ123/Face-Attendance.git
  2. Frontend Setup

  • Navigate to the frontend directory

    cd frontend/face_attendance
  • Install the dependencies

    flutter pub get
  • After your Backend is running, paste localhost:port or your IP Address (if USB Debugging) in the constants.dart file.

    const String BASE_URL = 'localhost:8000';
  1. Backend Setup
  • Navigate to the backend directory

    cd backend
  • Create and activate a virtual environment (recommended)

    python -m venv venv
    source venv/bin/activate
  • Install the dependencies

    pip install -r requirements.txt
  • Run the migrations

    python manage.py makemigrations
  • Run the migrations

    python manage.py migrate
  • Create a superuser

    python manage.py createsuperuser
  • Copy .env.example to .env

    copy .env.example .env
  • Edit the .env file and add the required values (SECRET_KEY & DEBUG)manage.py runserver

Usage

  • Run the server

    python manage.py runserver
  • Run the app

    flutter run

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT