Skip to content

Kyne0328/GateKeep

Repository files navigation

GateKeep

GateKeep is an Android app designed to facilitate entry tracking for schools. It has two types of accounts: Student and Admin.

Student Account

The Student account is for the attendees of the school. They will have a unique QR code assigned to them after signing up which will be used by the Admin to track their entry record. The QR code will contain the student's name, grade level and section.

Admin Account

The Admin account is for the person responsible for scanning the QR codes. They will use the app to scan the QR codes and record the attendance. The app will display the student's name once the QR code has been successfully scanned. After confirming the scanned QR code. the admin can go to the History tab to view more of the students data

Features

  • Easy attendance tracking for schools
  • Simple and intuitive user interface
  • Student and Admin account types
  • Unique QR codes assigned to each student
  • Student information displayed after successful scan
  • Real-time display of attendance records

Requirements

  • Latest Android Studio
  • Android device with minimum SDK version of 26 (Android 8.0 Oreo)
  • Internet connection

Installation

To install GateKeep, follow these steps:

  1. Download the GateKeep APK file to your Android device.
  2. Open the APK file to begin the installation process.
  3. Follow the on-screen instructions to complete the installation.

Note: Before installing, make sure that your device allows installation of apps from unknown sources. You can change this setting in your device's settings menu.

Building from source

  1. Clone the repository using git clone https://github.com/KyNe0328/GateKeep.git.
  2. Open the project in Android Studio.
  3. Connect your Android device to your computer using a USB cable.
  4. Select your device from the device drop-down menu in Android Studio.
  5. Click on the "Run" button in Android Studio to install and launch the app on your device.

Usage

  1. If you are the Admin, the app developer will give you your credentials or you can ask the developer to convert your account into an admin.
  2. If you are a Student, just open the app and register, once logged in you can display your QR code to the Admin.
  3. The Admin will scan your QR code using the app.
  4. Your name will be displayed on the Gate Keeper's device after a successful scan.

Support

If you encounter any issues or have any questions about the app, please contact us at kynskie13@gmail.com.

License

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