madhav-datt/kgp-hms

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# kgp-hms

[![Build Status](https://travis-ci.org/madhav-datt/kgp-hms.svg?branch=master)](https://travis-ci.org/madhav-datt/kgp-hms)
[![Code Climate](https://codeclimate.com/github/madhav-datt/kgp-hms/badges/gpa.svg)](https://codeclimate.com/github/madhav-datt/kgp-hms)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)]()
[![repo-size](https://reposs.herokuapp.com/?path=madhav-datt/kgp-hms)](https://reposs.herokuapp.com/?path=madhav-datt/kgp-hms)

<img src="https://github.com/madhav-datt/kgp-hms/blob/master/src/ui/resources/logo2.png" width="48">  Hall Management System for IIT Kharagpur. Has interfaces and functionalities for the following stakeholders:

* Hall Management Committee
* Wardens
* Hall Office Clerks
* Mess Managers
* Students

## Installation

To setup the software and configure the system to run, execute the following:

    $ cd kgp-hms
    $ chmod 755 install.sh
    $ ./install.sh
    
## Usage

### Hall Management Committee

    $ hmc

![hmc example screen](https://github.com/madhav-datt/kgp-hms/blob/master/src/ui/resources/hms.png)

### Wardens

    $ warden

![warden example screen](https://github.com/madhav-datt/kgp-hms/blob/master/src/ui/resources/warden.png)

### Hall Office Clerks

    $ clerk

![clerk example screen](https://github.com/madhav-datt/kgp-hms/blob/master/src/ui/resources/clerk.png)

### Mess Managers

    $ mess_manager

![mess manager example screen](https://github.com/madhav-datt/kgp-hms/blob/master/src/ui/resources/mess_manager.png)

### Students

    $ student

![student example screen](https://github.com/madhav-datt/kgp-hms/blob/master/src/ui/resources/student.png)