Documentation.md

Student Information System

Table of Contents

• Codebase Structure
• Design Choices
• Assumptions
• Limitations
• Screenshots

Codebase Structure

.
└── <StudentInformationSystem>/                                                 # Root directory of the project
    ├── main_app/                                                               # Main application directory
    │   ├── _pycache_                                                           # Python cache directory
    │   │ 
    │   ├── migrations/                                                         # Database migration files
    │   │   ├── _pycache_                                                       # Python cache directory for migrations
    │   │   ├── __init__.py                                                     # Initialization file for migrations
    │   │   └── 0001_initial.py                                                 # Initial migration file
    │   │ 
    │   ├── static/                                                             # Static files directory
    │   │   ├── dist/                                                           # Distribution directory
    │   │   │   └── <css img js>                                                # CSS, image, and JavaScript files
    │   │   ├── plugins/                                                        # Plugins directory
    │   │   │   └── <Bootstrap and Javascripts plugins>                         # Bootstrap and JavaScript plugins
    │   │   └── 01 PROJECT INFO.txt                                             # Information file about the project
    │   │ 
    │   ├── templates/ <.html>                                                  # HTML templates directory
    │   │   ├── hod_template                                                    # Head of Department (HOD) templates
    │   │   ├── main_app                                                        # Main application templates
    │   │   ├── registartion                                                    # Registration templates
    │   │   ├── staff_template                                                  # Staff templates
    │   │   └── student_template                                                # Student templates
    │   │ 
    │   ├── __init__.py                                                         # Initialization file for the main app
    │   ├── 01 PROJECT INFO.txt                                                 # Information file about the main app
    │   ├── admin.py                                                            # Django admin configuration file
    │   ├── apps.py                                                             # Django application configuration file
    │   ├── EditResultView.py                                                   # View file for editing results
    │   ├── EmailBackend.py                                                     # Email backend file
    │   ├── forms.py                                                            # Form definition file
    │   ├── hod_views.py                                                        # Views for Head of Department (HOD)
    │   ├── middleware.py                                                       # Middleware configuration file
    │   ├── models.py                                                           # Database models file
    │   ├── staff_views.py                                                      # Views for staff members
    │   ├── student_views.py                                                    # Views for students
    │   ├── test.py                                                             # Test file
    │   ├── urls.py                                                             # URL configurations
    │   └── views.py                                                            # Views file
    │
    ├── media/                                                                  # Directory for saved uploaded images
    │
    ├── student_information_system/                                             # Student Information System directory
    │   ├── _pycachce_                                                          # Python cache directory
    │   ├── __init__.py                                                         # Initialization file
    │   ├── 01 PROJECT INFO.txt                                                 # Information file about the project
    │   ├── asgi.py                                                             # ASGI configuration file
    │   ├── settings.py                                                         # Django settings file
    │   ├── urls.py                                                             # URL configurations
    │   └── wsgi.py                                                             # WSGI configuration file
    │
    ├── 01 PROJECT INFO.txt                                                     # Information file about the project
    ├── db.sqlite3                                                              # SQLite database file
    ├── LICENSE                                                                 # License file
    ├── manage.py                                                               # Django management file
    ├── Procfile                                                                # File for specifying Heroku process types
    └── requirements.txt                                                        # File listing required libraries and dependencies

Design Choices

This system application is about a Student Information System which aims to facilitate the management and administration tasks in a college or educational institution. It includes features such as student enrollment, course management, faculty administration, attendance tracking, exam management, and generating reports.

In this system, there are four main models which act as Python classes that represent database tables. These models then can perform Create, Read, Update, Delete (CRUD) operations and implement various functionalities. Below are the models:

• Course: Educational program that students can enroll in
• Subject: Specific topic or class within a course
• Session: Academic period
• Student: Individual who is enrolled in the college
• Staff: Individual who gives lecture to the students

Below are the tools and languages that are used in developing this system:

• Python: Main programming language
• Django: Web framework
• HTML: Creating the base structure
• CSS: Styling the system
• JavaScript: Adding interactivity and dynamic features

Assumptions

When developing a college management system, there can be several common assumptions that might apply. Below are the assumptions found:

• The system assumes a standard college or educational institution setup with typical administrative and academic processes.
• It assumes that the college management system will be used by authorized staff members, students, and faculty members who have appropriate credentials.
• It assumes that the necessary hardware and infrastructure, such as servers, databases, and internet connectivity, are available for the system to operate effectively.
• It assumes that the system will support a specific number of users, courses, subjects, and other entities based on the anticipated requirements.

Limitations

There are also limitations and drawbacks that may be present when designing the system. Below are the limitations:

• The system might have limitations in terms of scalability, performance, and handling a large volume of data or concurrent users.
• It may not address all the specific needs and requirements of every college or educational institution, as different institutions may have unique processes and workflows.
• The system might not include advanced features or specialized functionalities that could be required by specific colleges.
• It may have limitations in terms of customization, requiring additional development effort to adapt it to the specific needs of a particular institution.

Screenshots

• Login

• Dashboard

• Update Profile

• Student Page

• Add Course

• Manage Course

• Add Session

• Manage Session

• Add Staff

• Manage Staff

• Add Student

• Manage Student

• Add Subject

• Manage Subject

• Notify Staff

• Notify Student

• View Notification

• View Attendance

• View Attendance Student

• Apply Leave

• Staff Leave

• Student Leave

• Feedback Form

• Staff Feedback

• Student Feedback