https://github.com/yashksaini-coder/relay-chat-backend

https://github.com/yashksaini-coder/relay-chat-backend

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/yashksaini-coder/relay-chat-backend
• Owner: yashksaini-coder
• Created: 2024-12-13T11:51:19.000Z (6 months ago)
• Default Branch: dev
• Last Pushed: 2024-12-13T17:34:49.000Z (6 months ago)
• Last Synced: 2024-12-13T18:32:35.314Z (6 months ago)
• Language: TypeScript
• Size: 20.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# WebSocket Chat Application

A simple WebSocket-based chat application where users can create, join, and chat in rooms.

## 📦 Prerequisites

| ![TypeScript](https://skillicons.dev/icons?i=typescript) | ![Node.js](https://skillicons.dev/icons?i=nodejs) | ![Git](https://skillicons.dev/icons?i=git) |

|-----------------|---------|------|

## ✨ Features  

- Create a room ID with a unique 6-character code. 🔑

- Join existing chat rooms. 🚪

- List active rooms with the number of users. 📋

- Real-time chat functionality (message polling). 💬

## 📁 Project Structure

```

.

├── .gitignore

├── dist/

│   └── index.js

├── node_modules/

├── package-lock.json

├── package.json

├── README.md

├── src/

│   └── index.ts

├── tsconfig.json

└── tsconfig.tsbuildinfo

```

## 🛠️ Setup Instructions

1. Clone the repository:

   ```bash

   git clone https://github.com/yashksaini-coder/relay-chat-backend

   cd relay-chat-backend

   ```

2. Install dependencies:

   ```bash

   npm install

   ```

3. Start the server:

   ```bash

   npm run dev

   ```

### 🧪 Testing:

To test the updated functionality, you can use a Postman and use the Websocket server instance. These are the messages to check the functionality:

![Postman Testing](./assets/img/testing.png)