Skip to content

Latest commit

Β 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Chat Engine System β€” Real-Time Chat Engine πŸ’¬

A lightweight, real-time chat application engine built with Node.js and JavaScript, utilizing WebSockets for instantaneous bi-directional communication. This project was developed as a hands-on learning environment to master asynchronous event-driven architectures and scalable backend design patterns.


πŸ› οΈ Software Architecture & Directory Structure

The backend follows a rigid modular architecture to ensure separation of concerns, decoupling transport protocols, business rules, and state data.

β”œβ”€β”€ controllers/          # Request payload handling and orchestration
β”‚   β”œβ”€β”€ channelController.js
β”‚   β”œβ”€β”€ chatController.js
β”‚   └── controller.js
β”œβ”€β”€ models/               # Data layer abstractions and entity schemas
β”‚   β”œβ”€β”€ channel.js
β”‚   └── message.js
β”œβ”€β”€ routes/               # Architectural API routing entry points
β”‚   β”œβ”€β”€ groups/
β”‚   β”‚   β”œβ”€β”€ channelRoutes.js
β”‚   β”‚   └── chatRoutes.js
β”‚   └── api.js
β”œβ”€β”€ services/             # Isolated core business logic layer
β”‚   β”œβ”€β”€ channelService.js
β”‚   └── chatService.js
β”œβ”€β”€ server.js             # HTTP REST API server initialization
└── serverWebsocket.js    # Socket.io connection and event orchestration

πŸš€ Getting Started & Local Deployment

  1. Prerequisites Ensure you have Node.js installed on your local host system.

  2. Installation Clone the repository and install the development and runtime dependencies:

npm install
  1. Running the Application Start the local server configurations:
npm start

The application bootstrapper will initialize, exposing both the REST API endpoints and the live WebSocket gateway.

πŸ”§ Core Tech Stack

  • Runtime Environment: Node.js (JavaScript)
  • API Framework: Express
  • WebSocket Engine: Socket.io

About

πŸ’¬βš‘ A modular real-time chat engine built with Node.js, Socket.io, and an isolated MVC/Services pattern.

Topics

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages