Skip to content

MohnishKJ/HelpWave

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

17 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

HelpWave 🌊

Real-time collaborative help board where users create or join a room and post doubts instantly, with live updates across all participants.

πŸš€ What it does

  • Create or join a room using a unique room code
  • Post doubts and get instant replies in real time
  • Mark doubts as resolved
  • Live member count tracking per room
  • Host controls to manage or end a room, with automatic host reassignment if the host leaves
  • Session persists on refresh, no accidental logouts

βš™οΈ How it works

  • React (Vite) frontend communicates with a Flask backend
  • Real-time updates handled through Flask-SocketIO and Socket.IO Client
  • Room and doubt data stored using SQLAlchemy with SQLite
  • Backend deployed on Render, frontend deployed on Netlify

πŸ”— API Endpoints

Room Management

  • POST /create-room β€” creates a new room and returns a unique room code
  • POST /join-room β€” joins an existing room using { "code": "AB12" }
  • GET /room-items/<room_code> β€” fetches all doubts for a room

Doubt Management

  • POST /items β€” creates a new doubt
{
  "room_code": "AB12",
  "guest_name": "User",
  "type": "doubt",
  "title": "Sample doubt",
  "description": "Optional description"
}
  • POST /resolve β€” marks a doubt as resolved
{ "item_id": 1 }

Reply System

  • POST /reply β€” adds a reply to a doubt
{
  "item_id": 1,
  "guest_name": "User",
  "message": "Reply message"
}

WebSocket Events (Socket.IO)

  • join_room β€” join a specific room
  • item_created β€” broadcast new doubt
  • item_replied β€” broadcast new reply
  • item_resolved β€” broadcast resolved doubt
  • item_flagged β€” broadcast auto-flagged doubts
  • force_leave_all β€” host ends the room for all
  • member_update β€” live member count update
  • host_changed β€” new host assignment

πŸ› οΈ Tech Stack

Frontend

  • React (Vite)
  • JavaScript
  • HTML5
  • CSS3
  • Socket.IO Client

Backend

  • Python
  • Flask
  • Flask-SocketIO
  • SQLAlchemy
  • SQLite

Deployment

  • Render (Backend)
  • Netlify (Frontend)

Version Control

  • Git
  • GitHub

πŸ‘€ Owner & Author

Mohnish KJ Final Year B.E CSE (AI&ML) Student | AI & ML Enthusiast

Built as a full-stack real-time web application using React, Flask, and Socket.IO.

About

Real-time collaborative doubt board with live room-based chat using WebSockets 🌊

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors