BunQMate - Attendance Tracker

Calculate how many classes you can safely skip without falling below minimum attendance requirements

---

About The Project

BunQMate is a modern, client-side web application (currently) designed to help college students track their attendance and make informed decisions about which classes they can safely skip (or "bunk") without dropping below the required attendance percentage.

The application provides instant calculations showing:

• How many classes you need to attend to meet minimum requirements
• How many classes you can safely skip
• Your current attendance percentage per subject and overall

All calculations happen client-side in real-time—no backend, no database, complete privacy.

---

Features

Core Functionality

• Real-time Attendance Calculations: Instant feedback as you update your data
• Per-Subject Tracking: Manage attendance for multiple subjects independently
• Overall Statistics: View combined attendance across all subjects
• Classes Missed Integration: Accurate calculations considering already missed classes
• Safe Bunk Calculator: Know exactly how many classes you can skip

Timetable Management

• Interactive Timetable Builder: Visual grid for weekly schedule input
• Excel Import/Export: Upload your timetable from Excel files
• Auto-population: Automatically generate subjects from your timetable
• Downloadable Template: Pre-formatted Excel template for easy setup

Tech Stack

Frontend Framework:

• React 18.x
• Vite 5.x
• CSS

Libraries:

• xlsx - Excel file parsing and generation
• recharts - Data visualization (charts)

Language:

• JavaScript (ES6+)

---

Usage

Quick Start Guide

1. Add Subjects Manually

   • Click "Add Subject" button
   • Fill in: Subject Name, Total Classes, Attended, Missed, Min %
   • View instant calculations in the table below

2. Import from Timetable

   • Click "Import from Timetable"
   • Either fill the grid manually OR
   • Download the Excel template
   • Fill it with your weekly schedule
   • Upload the completed file
   • Click "Import Subjects" to auto-generate your subject list

3. View Analytics

   • Check the Overview card for overall stats
   • Review Subject Breakdown table for detailed per-subject data
   • Visualize attendance percentages in the pie chart

4. Calculate Safe Bunks

   • The "Max Bunkable" column shows how many classes you can skip
   • Green numbers = safe to bunk
   • Update "Attended" and "Missed" after each class for accuracy

Contributing

Any contributions you make are greatly appreciated.

How to Contribute

1. Fork and then Clone the Project

   git clone https://github.com/yourusername/attendance-tracker.git

2. Create your Feature Branch

   git checkout -b feature/<your-feature-name>

3. Commit your Changes

   git commit -m '<your-feature>'

4. Push to the Branch

   git push origin feature/<your-feature-name>

5. Open a Pull Request

Development Guidelines

• Follow the existing code style and structure
• Write clean, commented code
• Test your changes thoroughly
• Update documentation as needed
• Keep commits atomic and well-described

Areas for Contribution

• UI/UX improvements
• Bug fixes
• New features

---

Roadmap

• Basic attendance calculation
• Timetable import feature
• Excel upload support
• Dark/Light theme toggle
• localStorage persistence
• PDF export functionality
• Calendar Support - accounting for holidays and the such
• Progressive Web App (PWA) support
• Multi-semester tracking
• Calendar integration
• Attendance reminders/notifications
• User-Login, Authentication
• Backend and Database

---

That's all I could think of for now, happy bunking :)