Skip to content

Latest commit

 

History

History
146 lines (114 loc) · 4.29 KB

README.md

File metadata and controls

146 lines (114 loc) · 4.29 KB
Raw

Mess Website - Website for Central Dining Facility at IIT Indore

A Django-based software project that automates and digitalises the complete dining system of IIT Indore.

Features

  • Automated rebate rule checks
  • Student information access
  • Automated allocation of caterers
  • Email notifications
  • Billing automation

Ongoing development of additional features ...

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contact

About the Project

The Mess Website is a Django-based software project that automates and digitalises the complete dining system of IIT Indore. It is a web application that provides a platform for students to fill short and long rebates, caterer allocation forms, access their dining bills and other information. It also provides a platform for the institute's administrations to manage the dining system and the students of IIT Indore.

(back to top)

Built With

  • Django
  • SQlite
  • Bootstrap
  • python
  • Docker
  • Gunicorn
  • Nginx

Getting Started

Follow these instructions to set up and run the project locally on your machine.

Prerequisites

Before you begin, ensure you have the following installed:

  • Python 3.10 +

Installation

  1. Clone the repository

     git clone https://github.com/DaemonLab/Mess-Website.git

  2. Navigate to the project directory:

    cd Mess-Website

  3. Install all dependencies

    pip install –-user -r requirements.txt

  4. Create a superuser

    python manage.py createsuperuser

  5. Migrate the database

    python manage.py migrate

  6. Copy the environment

    cp .env.example .env

  7. Edit the environment variables in .env file

  8. Finally run

    python manage.py runserver

Note: SQLite is as the default database

Pre-Commit Hooks

  1. This project uses pre-commit hooks to ensure code quality. To install pre-commit hooks, run the following command:

    pip install pre-commit
pre-commit install

  2. To run pre-commit hooks manually, run the following command:

    pre-commit run --all-files

Roadmap

  • Student Information Access
  • Short Rebate Form
  • Long Rebate Form
  • Caterer Allocation Form
  • Billing System - for both students and caterers
  • Email Notifications
  • Scan QR Code feature

(back to top)

Contact

Project Link: https://github.com/DaemonLab/Mess-Website