https://github.com/basemax/chattypescriptsocketio
This is a real-time chat application built with TypeScript and Socket.io, allowing users to communicate through direct messages, group messages, and channels. The application offers bidirectional communication between clients and the server, providing a seamless chat experience.
https://github.com/basemax/chattypescriptsocketio
javascript javascript-socket javascript-socketio socket-io socket-typescript socketio typescript typescript-socket typescript-socketio
Last synced: 3 months ago
JSON representation
This is a real-time chat application built with TypeScript and Socket.io, allowing users to communicate through direct messages, group messages, and channels. The application offers bidirectional communication between clients and the server, providing a seamless chat experience.
- Host: GitHub
- URL: https://github.com/basemax/chattypescriptsocketio
- Owner: BaseMax
- License: gpl-3.0
- Created: 2023-07-17T11:38:40.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-17T11:07:29.000Z (6 months ago)
- Last Synced: 2025-03-28T17:08:04.388Z (4 months ago)
- Topics: javascript, javascript-socket, javascript-socketio, socket-io, socket-typescript, socketio, typescript, typescript-socket, typescript-socketio
- Language: TypeScript
- Homepage:
- Size: 1.04 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TypeScript Chat Socket IO Project
This is a real-time chat application built with TypeScript and Socket.io, allowing users to communicate through direct messages, group messages, and channels. The application offers bidirectional communication between clients and the server, providing a seamless chat experience.
## Features
- **User-to-User Direct Messaging:** Users can send direct messages to each other privately.
- **Group Messaging:** Users can participate in group conversations with multiple participants.
- **Channels:** Users can join and send messages to public channels.## Prerequisites
Before running this project, ensure you have the following prerequisites installed on your system:
- Node.js (v18.13.0)
- npm (Node Package Manager) "9.2.0"
- Socket.io "^4.7.1"## Getting Started
Clone this repository to your local machine:
```bash
git clone https://github.com/BaseMax/ChatTypeScriptSocketIO
cd ChatTypeScriptSocketIO
```Install project dependencies:
```bash
npm install
```## Usage
### Starting the WebSocket Server
To start the WebSocket server, run the following command:
```bash
npm run start dev
```This will launch the server and bind it to a specified port (default is 8080). The server will be ready to accept WebSocket connections from clients.
The client will attempt to connect to the WebSocket server running on the specified host and port. You can adjust the server host and port in the postman events.
# Join to socket.io

# Private chat
## Get private

## Received private message

## Update private message

## Delete message in private chat

# Group


# Channel







## Configuration
You can modify the WebSocket server settings in the src/server.ts file:
- `PORT`: The port on which the WebSocket server will listen for incoming connections.
You can adjust the WebSocket client settings in the src/client.ts file:
- `SERVER_HOST`: The hostname or IP address of the WebSocket server.
- `SERVER_PORT`: The port on which the WebSocket server is running.## Contributing
Contributions to this project are welcome. If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.
## License
This project is licensed under the GPL-3.0 License.
Copyright 2023, Max Base