CoolFace
Apppublic

MrUnfazed/Basic-Student-Management-Project

sourceHugging Facemitupdated 1y agoView on Hugging Face
1likes
App README

๐ŸŽ“ Student Management System

A modern, comprehensive web-based student management system built with Python and Gradio. This application provides an intuitive interface for generating detailed student reports combining academic performance, sports activities, and attendance records.

โœจ Features

๐Ÿ“Š Comprehensive Student Profiles

  • โ€”Personal Information Management: Name, father's name, age, date of birth, contact details
  • โ€”Academic Records: Roll number, department, semester tracking
  • โ€”Multi-subject Grade Tracking: Physics, AICT, Programming, English, Mathematics, and more
  • โ€”Laboratory Scores: Separate tracking for practical subjects

๐Ÿ† Sports Performance Tracking

  • โ€”Multi-sport Support: Football, Cricket, Table Tennis, Hockey
  • โ€”Flexible Participation: Only tracks sports the student actually participated in
  • โ€”Automatic Score Calculation: Computes total sports performance scores

๐Ÿ“… Attendance Management

  • โ€”Percentage-based Tracking: Easy-to-understand attendance percentages
  • โ€”Input Validation: Ensures attendance values stay within 0-100% range

๐ŸŽจ Modern User Interface

  • โ€”Responsive Design: Works seamlessly on desktop and mobile devices
  • โ€”Gradient Styling: Beautiful purple-blue gradient theme with glassmorphism effects
  • โ€”Interactive Elements: Hover effects, smooth animations, and micro-interactions
  • โ€”Dark Mode Support: Automatic theme adaptation
  • โ€”Professional Typography: Inter font family for modern aesthetics

๐Ÿš€ Quick Start

Prerequisites

  • โ€”Python 3.8 or higher
  • โ€”pip (Python package installer)

Installation

  1. 1.Clone the repository
bash
git clone <repository-url>
cd student-management-system
  1. 1.Install dependencies
bash
pip install -r requirements.txt
  1. 1.Run the application
bash
python app.py
  1. 1.Access the application
  2. 2.Local: http://localhost:7860
  3. 3.Public URL will be displayed in terminal (if share=True)

๐Ÿ—๏ธ Technical Architecture

Object-Oriented Design

The application follows clean OOP principles with multiple inheritance:

Person (Base Class)
โ”œโ”€โ”€ Student (Inherits from Person)
    โ”œโ”€โ”€ Test (Inherits from Student)
    โ”œโ”€โ”€ Sport (Inherits from Student)  
    โ”œโ”€โ”€ Attendance (Inherits from Student)
    โ””โ”€โ”€ Result (Multiple Inheritance from Test, Sport, Attendance)

Class Structure

๐Ÿ‘ค Person Class
  • โ€”Purpose: Base class for personal information
  • โ€”Attributes: name, father's name, age, DOB, contact, email
  • โ€”Methods: Setters and display functionality
๐Ÿ“š Student Class
  • โ€”Purpose: Academic information management
  • โ€”Attributes: roll number, department, semester
  • โ€”Inheritance: Extends Person class
๐Ÿ“ Test Class
  • โ€”Purpose: Academic performance tracking
  • โ€”Subjects: Physics, AICT, Programming, English, Islamic Studies, Calculus
  • โ€”Features: Individual subject scores and lab work tracking
๐Ÿ† Sport Class
  • โ€”Purpose: Sports performance management
  • โ€”Sports: Football, Cricket, Table Tennis, Hockey
  • โ€”Features: Optional participation tracking and automatic total calculation
๐Ÿ“… Attendance Class
  • โ€”Purpose: Attendance record management
  • โ€”Features: Percentage-based tracking with validation
๐Ÿ“Š Result Class
  • โ€”Purpose: Comprehensive report generation
  • โ€”Inheritance: Multiple inheritance from Test, Sport, and Attendance
  • โ€”Features: Total marks calculation and formatted report output

๐Ÿ“ฑ User Interface

Input Sections

  • โ€”Personal Information: Student demographic data
  • โ€”Academic Information: Educational details
  • โ€”Test Scores: Subject-wise academic performance (0-100 scale)
  • โ€”Sports Performance: Optional sports participation scores
  • โ€”Attendance: Percentage-based attendance tracking

Output Features

  • โ€”Formatted Reports: Professional-looking comprehensive student reports
  • โ€”Copy Functionality: Easy report copying for external use
  • โ€”Real-time Generation: Instant report creation upon form submission

๐Ÿ› ๏ธ Deployment

Hugging Face Spaces

This application is optimized for deployment on Hugging Face Spaces:

  1. 1.Create a new Space on Hugging Face
  2. 2.Upload app.py and requirements.txt
  3. 3.The application will automatically deploy

Local Development

bash
# Install in development mode
pip install -e .

# Run with auto-reload
python app.py

Docker Deployment

dockerfile
FROM python:3.9-slim
WORKDIR /app
COPY requirements.txt .
RUN pip install -r requirements.txt
COPY . .
EXPOSE 7860
CMD ["python", "app.py"]

๐Ÿ“‹ Requirements

Python Dependencies

gradio==4.44.0
numpy==1.24.3
pandas==2.0.3

System Requirements

  • โ€”RAM: Minimum 512MB
  • โ€”Storage: 100MB free space
  • โ€”Network: Internet connection for font loading

๐ŸŽฏ Use Cases

Educational Institutions

  • โ€”Schools: K-12 student record management
  • โ€”Colleges: University student tracking
  • โ€”Coaching Centers: Performance monitoring

Administrative Tasks

  • โ€”Report Generation: Quick student performance reports
  • โ€”Data Entry: Streamlined information input
  • โ€”Performance Analysis: Comprehensive student evaluation

๐Ÿค Contributing

We welcome contributions! Please follow these steps:

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

Development Guidelines

  • โ€”Follow PEP 8 style guidelines
  • โ€”Add comments for complex logic
  • โ€”Test all features before submitting
  • โ€”Update documentation as needed

๐Ÿ“„ License

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

๐Ÿ‘ฅ Authors

  • โ€”MrUnfazed - Creator and Lead Developer

๐Ÿ™ Acknowledgments

  • โ€”Gradio Team - For the amazing web interface framework
  • โ€”Google Fonts - For the Inter font family
  • โ€”CSS Community - For glassmorphism design inspiration

๐Ÿ“ž Support

If you encounter any issues or have questions:

  1. 1.Check existing issues in the repository
  2. 2.Create a new issue with detailed description

๐Ÿ”„ Version History

  • โ€”v1.0.0 - Initial release with core functionality
  • โ€”v1.1.0 - Added modern UI with animations
  • โ€”v1.2.0 - Enhanced responsive design

๐Ÿšง Roadmap

Upcoming Features

  • โ€”[ ] Database Integration - Persistent data storage
  • โ€”[ ] PDF Export - Generate downloadable reports
  • โ€”[ ] Bulk Import - CSV/Excel data import functionality
  • โ€”[ ] Analytics Dashboard - Performance visualization charts
  • โ€”[ ] Multi-language Support - Internationalization
  • โ€”[ ] User Authentication - Secure access control

<div align="center">

Built with โค๏ธ using Python & Gradio by MrUnfazed

</div>