College Attendance System

A modern, web-based attendance management system for academic institutions, built with React, Django, and Tailwind CSS.

Get Started · Report a Bug · Request a Feature

---

Table of Contents

• About The Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgments

---

About The Project

The College Attendance System is a centralized, web-based platform designed to automate and streamline attendance management in academic institutions. It addresses the inefficiencies of manual attendance tracking by providing real-time insights, secure data storage, and role-based access for students, faculty, and administrators. Built with a scalable architecture using React, Django, SQLite3, and Tailwind CSS, the system supports future enhancements like biometric integration and analytics dashboards.

Built With

• React.js
• Django
• Tailwind CSS
• SQLite3
• JavaScript (ES6+)

---

Getting Started

Follow these steps to set up the College Attendance System locally.

Prerequisites

Ensure you have the following installed:

• Node.js (v16.x or later)
• Python (v3.9 or later)
• pip
• npm (v8.x or later)

Installation

Clone the repository

git clone https://github.com/your-username/college-attendance-system.git

Navigate to the project directory

cd college-attendance-system

Install backend dependencies

pip install -r api/requirements.txt

Install frontend dependencies

cd attendance_system && npm install

Set up the database

python api/manage.py migrate

Start the Django server

python api/manage.py runserver

Start the React development server

npm start

Access the application at http://localhost:3000

---

Usage

• Students: Log in to view attendance records, download reports, and monitor real-time status.
• Faculty: Mark attendance using facial recognition and manage class schedules.
• Administrators: Oversee user accounts, generate institutional reports, and monitor trends.

For detailed instructions, refer to the user guide.

---

Roadmap

• Implement user authentication and role-based access
• Develop attendance tracking with facial recognition
• Generate downloadable attendance reports
• Integrate biometric authentication (fingerprint/facial)
• Add mobile app support
• Implement real-time notifications for attendance issues

See the open issues for more details.

---

Contributing

We welcome contributions to enhance the College Attendance System! To contribute:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/YourFeature)
3. Commit your changes (git commit -m 'Add YourFeature')
4. Push to the branch (git push origin feature/YourFeature)
5. Open a pull request

Please adhere to our code of conduct.

---

License

Distributed under the MIT License. See LICENSE for more information.

---

Contact

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your-username/college-attendance-system

---

Acknowledgments

• Django Documentation
• React Documentation
• Tailwind CSS Documentation
• SQLite Documentation
• Choose an Open Source License

---

Notes:

• Replace your-username with your actual GitHub username.
• Update the logo.png path if the logo is stored elsewhere in the student_images folder.
• Add a requirements.txt file in the api folder with Django and other dependencies.
• Create a docs folder with a user-guide.md for detailed usage instructions if needed.
• Adjust the license and contact details as per your preference.

---