Attendance Tracker SRMAP Unofficial

https://github.com/AndysTMC/Attendance-Tracker-SRMAP

Description

The Attendance Tracker is a specialized tool created for educational purposes, specifically tailored to streamline attendance monitoring for students. It's designed for those with knowledge of GitHub repository usage and offers a unique opportunity for student developers to gain practical experience with a range of technologies.

Target Audience

This project is intended for:

(Student) Developers: Those looking to enhance their skills by working with real-world technologies, including Django, Selenium, Tesseract OCR, and Flutter.
Students: Students seeking an effective way to manage attendance in their courses.

Overall, this project demonstrates using automation and optical character recognition to simplify attendance tracking. It's a great learning project for student developers.

Prerequisites

Before you can get started with the Attendance Tracker project, there are several prerequisites and dependencies you'll need to have in place. Please ensure that you have the following tools and software installed:

Python: The project relies on Python for various components.

• Make sure you have Python (version >= 3.10) installed on your system.
• You can download it from the official Python website.

Git: To use or work with the project's source code and collaborate with others, make sure you have Git installed. You can download it from the official Git website.

Optional(only for developers):

Flutter: The mobile application component is built using Flutter, a framework by Google for building natively compiled applications for mobile from a single codebase. Follow the installation guide on the Flutter website to set up Flutter on your development machine.
Android Studio: Android Studio is essential for Flutter development, as it provides the Android Emulator and other tools. You can download and install Android Studio from the official Android Studio website.

Getting Started (Installation)

Installation.mp4

Follow these steps to install and set up the Attendance Tracker project on your local machine: (Ensure that the prerequisites are fulfilled)

• Clone the Repository: Start by cloning the project's repository to your local machine. Open your terminal or command prompt and execute the following command, replacing with the actual URL of your project's repository:
  
  

  git clone https://github.com/AndysTMC/Attendance-Tracker-SRMAP.git
  

• Navigate to the Project Directory: Change your working directory to the project's root folder:
  
  

  cd Attendance-Tracker-SRMAP
  

• Installing the Tesseract Library: Download and install the Tesseract Executable. During installation, specify the path to the path/to/Attendance-Tracker-SRMAP/Server/lib/ folder.
• Install Python Packages:
  Navigate to the server folder of the project and install the required Python packages by running install_requirements.bat file
• Install Flutter Dependencies and Build Application(for developers):
  
  Navigate to the app folder:
  
  

      cd Path/to/Attendance-Tracker-SRMAP/Source
  

  Install the flutter dependencies
  

      flutter pub get
  

  (If you're building application for android) Connect your mobile device to your PC and enable USB Debugging. Once connected, you can build the flutter application in two ways

  • Click the 'RUN' button in your integrated development environment (IDE)
  • Alternatively, use the command:

  flutter run
  

  
  NOTE: It is advisable to prioritize either the Android or Windows platform at this time, as the application has not undergone testing on alternative platforms.
• Install Android Platform Application(for students): Install the Attendance Tracker Android Application
• Install Widnows Platform Application(for students): Install the Attendance Tracker Windows Application

Usage

Follow these instructions to effectively use the Attendance Tracker:

Server

ServerRunDemo.mp4

• Click on the runserver.bat file in located at Path/to/Attendance-Tracker-SRMAP/Server/ of the cloned repository on your machine to run the server.

NOTE: You cannot update or get into the flutter application unless the server is turned on

Flutter Application

On Android

• Open the application
• Enter required details
• Click on 'GET IN' to scan the QR code (generated on your machine when server was started)
• That's it. Enjoy the application.
• Scan the QR code by clicking on the QR scanner icon inside the application whenever needed to update your attendance

On Windows

• Open the application
• Enter required details
• Click on 'GET IN' to enter into the application
• That's it. Enjoy the application.
• Click on the Refresh icon inside the application whenever needed to update your attendance