DOCUMENTATION
for
HOSTEL ROOM ALLOCATION
AND MAINTENANCE SYSTEM
Prepared by
Group Number: 19
Mohammed Ismail C B180437CS
Fadi Noushad P B180492CS
Muhammed Shifan P B180501CS
Abid Ali Karuvally Pathikkal B180466CS
Indrajith T S B180486CS
Instructor: Dr. Abdul Nazeer K A
Course: Database Management System
TABLE OF CONTENTS
[Link] [Link]
1
Modules 3
2
Code Description 5
3
Input and Output Format 6
4
How to get it running 8
2
1. MODULES
The project has been a Main module and three parallel modules.
[Link]
2. Hostel Manager
[Link]
The main directory contains the login and sign-up files for each of these
modules.
Each of these three modules contain the files necessary for its functioning
which includes the backend code as well as the frontend code.
1.1. Main Module
The main module(or directory) houses all other modules. Moreover, this
module contains the login forms of Admin,Hostel Manager and Student in
addition to the sign-up form of the Student.
It accepts the required data and redirects the user to the concerning
module.
1.2. Admin Module
This module deals with the functionality of the Administrator.
The assumption is that a particular Administrator has been previously hard-
coded into the database.
As previously mentioned the module contains both the frontend and backend
pertaining to it.
With respect to this application an Administrator can:
[Link] a Hostel Manager
[Link] a Hostel Manager
[Link] for particular students.
3
[Link] his/her profile.
The provision to perform all of the above tasks are included in this specific
module.
1.3. Hostel Manager Module
This module deals with the functionality of the Hostel Manager. Each
Hostel has a particular Hostel Manager who oversees the maintenance
and day to day of that particular [Link] Hostel Manager has been
previously appointed by the Administrator.
With respect to this application a Hostel Manager can:
1. Allocate Students in accordance with the application submitted by
them.
2. View the messages that are sent by the students to them.
[Link] all the Empty rooms or search for them.
[Link] all the allotted rooms or search for them.
[Link] a specific room.
[Link] his/her profile.
The provision to perform all of the above tasks are included in this specific
module.
1.4. Student
This module deals with the functionality of the Student.
Students sign-up through the main module and login through there.
With respect to this application a Hostel Manager can:
[Link] to a specific Hostel
2. Send a message to the Hostel Manager of their Hostel.
3. View the details of their profile which contains the details of
their hostel allocation (Not Alloted,Pending or Alloted).
The provision to perform all of the above tasks are included in this specific
module.
4
2. CODE DESCRIPTION
This being primarily a web application much of the entirety of this project
has been done with the help of PHP, MySQL, HTML, CSS and Javascript.
The Front end of a website is the part that users interact with and this has
been done with the help of HTML and CSS with the Bootstrap framework
in order to provide a responsive User Interface.
A General Layout of the Web Page was obtained from W3Layouts.
The Back end of a website consists of a server, an application, and a
database and has been done with the help of PHP and MySQL.
To run PHP for the web, you need to install a Web Server like Apache and
you also need a database server like MySQL. The open source web server
used is XAMPP.
Each module contains the necessary resources i.e the CSS files the
images,logos, necessary javascript files for bootstrap in addition to the PHP
code within itself, hence making it independent from the other modules and
thereby achieving a sense of modularity.
The main directory contains the three modules Admin,Hostel Manager and
[Link] of these modules contains the HTML,CSS and Javascript codes
necessary for its frontend function as well as the
PHP codes necessary for the backend functionalities.
5
3. INPUT AND OUTPUT FORMAT
Since it is primarily a web application this application has a very
intricate UI.
● Below given is a Sign up page for reference.
● After the corresponding entries have been it shows the
corresponding pop-up output which says that the action was
successful.
6
● After the action was completed we can see that our database has
changed according.
● After that it redirects to the corresponding page.
The navigation bar helps the user to seamlessly switch between the web
pages and choose the appropriate functionalities offered to them.
7
From here on out ,the entire application follows this type of an input and
output format
4. HOW TO GET IT RUNNING
In order to get a brief demonstration of the functionality of the
application follow the corresponding steps:
1. Download the code from github using the
link:[Link] em
into your local machine.
2. In Order to run an Apache server and a MySQL server download
xampp.
3.A ‘[Link]’ backup file has been provided in which some sample database
entries have been created load this into your corresponding MySQL
database.
4. Enter the relevant details into the database.
5. After entering in the address of the main directory of the code into your
localhost you will be greeted with this page.
8
6. Proceed in accordance with your use case.
7. In order to gain admin access,these are the sample admin details that are
provided in the ‘[Link]’ database.
Admin Username:’admin’
Admin Password:’admin’
You may use or change the details accordingly.
