Skip to content

IIM-Backrow/B3-SocketIO

Repository files navigation

🚀 Socket.IO Full-Stack Project

A comprehensive full-stack application showcasing real-time communication with Socket.IO, featuring a modern frontend and a robust Express backend with clean architecture.

🌟 Project Overview

This project demonstrates a complete Socket.IO implementation with:

  • 🎨 Frontend: Interactive user interface with real-time capabilities
  • ⚡ Backend: Express server with Socket.IO, TypeScript, and clean architecture
  • 🔗 Real-time Communication: Seamless bidirectional communication between client and server
  • 📘 Type Safety: Shared TypeScript types across the entire stack

🏗️ Project Structure

B3-SocketIO/
├── 🎨 frontend/              # Frontend application
├── ⚡ backend/               # Express/Socket.IO backend
├── 🔗 shared/               # Shared TypeScript types
└── 📚 docs/                # Complete documentation
    ├── backend/            # Backend-specific docs
    └── frontend/           # Frontend-specific docs

🚀 Quick Start

  1. 🐳 Docker (Recommended): See Docker Setup for containerized deployment
  2. ⚡ Backend: See Backend Documentation for setup and development
  3. 🎨 Frontend: See Frontend Documentation for setup and features
  4. 📚 Full Documentation: Browse the Documentation Index for comprehensive guides

📚 Documentation

🤝 Contributing

  1. Review the project documentation
  2. Follow the architecture patterns for your component (frontend/backend)
  3. Ensure code quality with linting and type checking
  4. Test real-time features across both frontend and backend

📄 License

This project is for educational purposes as part of the IIM B3 curriculum.

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors