Skip to content

srivtx/hostel-os

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HostelOS

The Future of Hostel Management

React FastAPI Three.js Tailwind SQLite

API Auth Status

Overview

HostelOS is a full stack system designed to digitize hostel operations through structured backend services and a unified interface It replaces manual workflows with scalable modules for tracking access control and internal coordination

The platform integrates visualization data systems and role based permissions into a single environment enabling efficient and maintainable hostel management

System Design

Client Layer
React based frontend handling UI rendering and state management

API Layer
FastAPI service exposing modular endpoints

Data Layer
SQLite with structured schema and migration scripts

Control Layer
Role based access control for admin and student operations

Visualization Layer
3D representation using React Three Fiber

Core Modules

Digital Twin
Real time room visualization mapped to backend state

Marketplace
Controlled student trading system

Mess System
Identity linked access with usage tracking

Attendance
Geolocation based validation system

Mailroom
Parcel tracking with secure verification

Energy Monitoring
Room level usage tracking and aggregation

Gate Pass
QR based entry system with logs

Getting Started

Backend

cd backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

python migrate_db.py
python migrate_parcels.py
python migrate_marketplace.py

uvicorn main:app --reload

Frontend

cd frontend
npm install
npm run dev

Access

Admin
username admin
password admin

Student
username 9328994892
password 9328994892

Notes

Built as a hackathon project and extended into a system design focused backend platform

About

everything that a modern hostel management system needs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors