Skip to main content

Quick start

This guide will help you set up and start using the QR Attendance System in just a few minutes.
Before starting, ensure you have completed the installation process.

Initial setup

1

Access the application

Open your web browser and navigate to your installation URL:
https://attendance.example.com
You should see the login page with the QR Attendance System logo.
2

Verify admin access

The system creates a default admin account automatically. While not required for basic usage, you can verify admin access:
  • Username: admin
  • Password: admin123
Change the default admin password in production by updating the database directly or through a custom admin panel.

Register a teacher account

1

Navigate to registration

From the login page, click the Register link.
2

Select Teacher Registration tab

Click on the Teacher Registration tab in the registration form.
3

Fill in teacher details

Enter the following information:
  • Teacher ID: Must follow format T followed by 4 digits (e.g., T1234)
  • Full Name: Your full name
  • Email: Valid email address
  • Password: Minimum 8 characters
  • Confirm Password: Must match password
Teacher ID: T1001
Name: John Smith
Email: [email protected]
Password: ••••••••
4

Complete registration

Click Create Teacher Account. You’ll see a success message and can now log in.

Register student accounts

1

Navigate to registration

From the login page, click the Register link.
2

Select Student Registration tab

Ensure the Student Registration tab is active (default).
3

Fill in student details

Enter student information:
  • Student ID: Any unique identifier (e.g., S12345)
  • Name: Student’s full name
  • Email: Valid email address
  • Password: Minimum 8 characters
  • Confirm Password: Must match password
Student ID: S12345
Name: Jane Doe
Email: [email protected]
Password: ••••••••
4

Save QR code

Upon successful registration, a unique QR code is displayed. Students should:
  • Take a screenshot of the QR code
  • Or access it anytime from their student dashboard
The QR code contains the student ID and is used for attendance marking.
Register 2-3 test student accounts to fully explore the system features.

Create your first class

1

Login as teacher

Log in using the teacher credentials you created:
User ID: T1001
Password: ••••••••
You’ll be redirected to the teacher dashboard.
2

Navigate to class management

Click Manage Classes from the teacher dashboard navigation.
3

Create a new class

Under “Create New Class”:
  • Enter a class name (e.g., “Computer Science 101”)
  • Click Create Class
Class Name: Computer Science 101
You’ll see a success message and the new class will appear in your class list.
4

Add students to class

In the class card:
  • Enter a student ID (e.g., S12345)
  • Click Add Student
Repeat for each student you want to enroll.
Students can only be enrolled in one class per teacher, but can be in classes from different teachers.

Configure class schedule

1

Navigate to schedule management

From the teacher dashboard, click Manage Schedule.
2

Select your class

Choose “Computer Science 101” from the class dropdown.
3

Add a schedule

Fill in the schedule details:
  • Day of Week: Select the class day (e.g., Monday)
  • Start Time: Enter class start time (e.g., 09:00)
  • Grace Period: Set late arrival tolerance in minutes (default: 15)
Day: Monday
Start Time: 09:00 AM
Grace Period: 15 minutes
Click Update Schedule.
4

Add more schedule slots (optional)

Repeat for other days if the class meets multiple times per week.

Mark attendance

1

Open the scanner

From the teacher dashboard, click Open Scanner.
Camera access requires HTTPS. If prompted, allow camera permissions in your browser.
2

Student displays QR code

The student logs into their dashboard and displays their QR code on screen.
3

Scan the QR code

Point your device camera at the student’s QR code. The system will:
  • Verify the student is enrolled in your class
  • Check if today matches a scheduled class day
  • Determine if attendance is on-time or late based on current time vs start time + grace period
  • Record the attendance
You’ll see a confirmation message:
  • ✅ “On-time attendance marked for Student ID: S12345”
  • ⚠️ “Late attendance marked for Student ID: S12345”
4

View attendance

Return to the teacher dashboard, select your class, and view today’s attendance under “Today’s Attendance” section.

Student workflow

Students can check their attendance and view schedules:
1

Login to student dashboard

Students log in with their credentials:
User ID: S12345
Password: ••••••••
2

View QR code

The dashboard displays their unique QR code prominently. Students can show this during class for attendance.
3

Check attendance history

The dashboard shows:
  • Total check-ins
  • Days attended
  • Recent attendance history with dates, times, and status (on-time/late/absent)
4

View class schedule

Click the Schedule tab to see:
  • Class name and teacher
  • Days and times
  • Grace period for each session

What’s next?

Now that you have the basics working:

Excel Import

Import entire class rosters from Excel files

Attendance Tracking

Learn about advanced attendance features

Teacher Guide

Complete teacher feature overview

Student Guide

Complete student feature overview

Common issues

QR scanner not working

  • Ensure you’re using HTTPS (required for camera access)
  • Check browser permissions for camera access
  • Try a different browser (Chrome/Firefox recommended)

Student not found when scanning

  • Verify student is enrolled in the teacher’s class
  • Check that today matches a scheduled class day in Manage Schedule
  • Ensure student ID matches exactly (case-sensitive)

Cannot add student to class

  • Student must be registered first
  • Student can only be in one class per teacher
  • Verify student ID is correct
For detailed troubleshooting, see the Installation guide or check the API documentation.

Build docs developers (and LLMs) love