Skip to content

Hilal-Anwar/GradedAttendance

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GradedAttendance

A comprehensive attendance management system with integrated grading capabilities, designed to streamline educational institution workflows and provide efficient student attendance tracking.

64521

🚀 Features

  • Smart Attendance Tracking: Automated attendance recording and management
  • Integrated Grading System: Direct correlation between attendance and academic performance
  • Responsive Desktop Interface: Modern, user-friendly design built with JavaFX and CSS
  • Real-time Analytics: Track attendance patterns and generate insights
  • Multi-user Support: Different access levels for administrators, teachers, and students

🛠️ Technology Stack

  • Backend: Java
  • Frontend: JavaFX, CSS
  • Build Tool: Maven
  • Database: SQLite

📋 Prerequisites

Before running this project, ensure you have the following installed:

  • Java 11 or higher
  • Maven 3.6+
  • Git
  • SQLite (ensure the SQLite JDBC driver is included in the project dependencies)

🚀 Installation & Setup

1. Clone the Repository

git clone https://github.com/Hilal-Anwar/GradedAttendance.git
cd GradedAttendance

2. Build the Project

Using Maven wrapper (recommended)

./mvnw clean install

Or using system Maven

mvn clean install

3. Run the Application

Using Maven wrapper

./mvnw javafx:run

Or using system Maven

mvn javafx:run

4. Access the Application

The application will launch a desktop window upon successful execution.

📁 Project Structure

GradedAttendance/
├── src/
│ ├── main/
│ │ ├── java/
│ │ │ └── [Java source files]
│ │ └── resources/
│ │     └── [CSS, FXML files, SQLite database file]
├── pom.xml
├── mvnw
├── mvnw.cmd
└── .gitignore

🎯 Usage

  1. Administrator Dashboard: Access comprehensive attendance and grading analytics
  2. Teacher Interface: Mark attendance, assign grades, and generate reports
  3. Student Portal: View personal attendance records and grades
  4. Reporting System: Generate detailed attendance and performance reports

🔧 Configuration

Database Configuration

Ensure the SQLite JDBC driver is included in your pom.xml. Example dependency:

<dependency>
    <groupId>org.xerial</groupId>
    <artifactId>sqlite-jdbc</artifactId>
    <version>3.46.1</version>
</dependency>

Configure the database connection in your application properties or configuration file. Example:

jdbc.url=jdbc:sqlite:graded_attendance.db

Application Properties

[Key configuration options to be documented]

🤝 Contributing

We welcome contributions! Please follow these steps:

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

Development Guidelines

  • Follow Java coding standards
  • Write unit tests for new features
  • Update documentation as needed
  • Ensure responsive design principles

📝 API Documentation

[API endpoints and usage documentation to be added]

🐛 Known Issues

  • [List any known issues or limitations]

🔄 Changelog

Version 1.0.0 (Current)

  • Initial release
  • Core attendance tracking functionality
  • Basic grading system integration
  • Responsive desktop interface

📜 License

This project is licensed under the [License Type] - see the LICENSE file for details.

👨💻 Author

Hilal Anwar

🙏 Acknowledgments

  • [Acknowledge any libraries, frameworks, or contributors]
  • [Thank any mentors or inspiration sources]

📞 Support

If you encounter any issues or have questions:

  1. Check the Issues page
  2. Create a new issue if your problem isn't already reported
  3. Contact the maintainer directly

🚀 Future Enhancements

  • Mobile application development
  • Advanced analytics dashboard
  • Integration with external LMS systems
  • Automated attendance using biometrics
  • Multi-language support
  • Email/SMS notifications

⭐ Star this repository if you find it helpful!